Obter chaves de arquivo

Serviço que retorna os assets armazenados em uma operação, indexados pelo seu contexto.

É a forma recomendada de obter as chaves que são enviadas aos serviços de validação, em vez de mantê-las no cliente.

Endpoint

GET /operation/{operationId}/file-keys

Cabeçalhos

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de consumer no formato Bearer <token>. Ver Autenticação.
consumer-id	string	Sim	Identificador do consumer.

Parâmetros de rota

Parâmetro	Tipo	Obrigatório	Descrição
operationId	string	Sim	Identificador da operação.

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro	Tipo	Descrição
operationId	string	Identificador da operação.
merchantReference	string	A referência indicada ao criar a operação. Não aparece se nenhuma foi informada.
fileKeys	object	Objeto indexado por contexto, em que cada valor é a chave do asset desse contexto. Os contextos sem asset armazenado não aparecem.

Exemplo de resposta

{
  "operationId": "0192a3f4-7b21-7c44-9e1a-3f5b8c2d1e04",
  "merchantReference": "ORD-4417",
  "fileKeys": {
    "TOKEN_FRONT_DOCUMENT": "0192a3f4-7b21-7c44-9e1a-3f5b8c2d1e04/TOKEN_FRONT_DOCUMENT",
    "TOKEN_BACK_DOCUMENT": "0192a3f4-7b21-7c44-9e1a-3f5b8c2d1e04/TOKEN_BACK_DOCUMENT",
    "TOKEN_BEST_IMAGE": "0192a3f4-7b21-7c44-9e1a-3f5b8c2d1e04/TOKEN_BEST_IMAGE"
  }
}

merchantReference é retornado para reconciliar a operação com o sistema próprio. Não é um critério de consulta: esta rota é direcionada por operationId.

Outras respostas

Código	Descrição
401	Token ausente, inválido ou expirado.
403	O consumer não está provisionado com o serviço OPERATION.
404	A operação não existe ou pertence a outro consumer.
410	A operação declarada em operation-id expirou.
429	O consumer ultrapassou seu limite de taxa de requisições. A resposta inclui Retry-After com os segundos de espera, e X-RateLimit-Limit e X-RateLimit-Burst com os limites vigentes.
503	O serviço não está disponível temporariamente.

O corpo de uma resposta de erro tem o formato descrito em MIDAPI v2.