Pular para o conteúdo
Veltra Ajuda
Manual da APIPlaybookEntrar

Manual da API · Leitura e consulta

Baixa a imagem original de uma foto do documento

GET/v1/saida/documentos/{id}/fotos/{fotoId}

Os bytes exatamente como o motorista enviou (sem recompressão), em JPEG ou PNG; confira o sha256 da lista se quiser provar que não mudou. Só a chave do TMS. Foto que não pertence ao documento responde 404 (FOTO_NAO_ENCONTRADA).

Para que serve: baixa a imagem original de uma foto da lista acima, exatamente como o motorista enviou, sem recompressão, em JPEG ou PNG.

Quando chamar: para cada item da lista de fotos, usando o caminho que veio nela. Só a chave do TMS usa.

Parâmetros

Cabeçalhos (header)

  • X-Veltra-Api-Keytextoobrigatório

    Chave de API do TMS. Emitida na tela Chaves de API do portal; o valor completo aparece uma única vez.

Caminho (path)

  • idtexto (uuid)obrigatório
  • fotoIdtexto (uuid)obrigatório

Respostas

200image/jpeg

Imagem da foto

403application/problem+json

CHAVE_SUSPENSA (no campo codigo): a chave de consulta está suspensa porque o add-on foi desligado. A chave não foi revogada e volta a funcionar quando o add-on for contratado de novo.

JSON
{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}
Campos da resposta (6)

Campos

  • typetextoobrigatório
  • titletextoobrigatório
  • statusinteiroobrigatório
  • detailtextoopcional
  • instancetextoopcional
  • codigotextoopcional

    Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

404application/problem+json

Documento ou foto inexistente (DOCUMENTO_NAO_ENCONTRADO ou FOTO_NAO_ENCONTRADA, no campo codigo).

JSON
{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}
Campos da resposta (6)

Campos

  • typetextoobrigatório
  • titletextoobrigatório
  • statusinteiroobrigatório
  • detailtextoopcional
  • instancetextoopcional
  • codigotextoopcional

    Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Erroapplication/problem+json

Erro no formato RFC 9457 (application/problem+json)

JSON
{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}
Campos da resposta (6)

Campos

  • typetextoobrigatório
  • titletextoobrigatório
  • statusinteiroobrigatório
  • detailtextoopcional
  • instancetextoopcional
  • codigotextoopcional

    Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Guia explicado

O que fazer: erros

401, 403 (chave que não é de TMS), 404 (DOCUMENTO_NAO_ENCONTRADO ou FOTO_NAO_ENCONTRADA, no campo codigo; foto que não pertence ao documento também responde 404), 429.

Observações

confira o sha256 da lista com o do arquivo baixado se quiser provar que a imagem não mudou.

Texto completo, com mais exemplos, em API por rota.