Manual da API · Leitura e consulta

Devolve o OpenAPI filtrado da finalidade

GET/v1/saida/openapi/{finalidade}

Grupos: integracao-tms (todas as rotas /v1/saida); consulta-embarcador e consulta-destinatario (somente leitura de documento, evento que não seja posicao.lote, e PDF só sob D-11).

Para que serve: devolve o OpenAPI filtrado (em YAML) com só as rotas que a finalidade pode chamar. Use para gerar um cliente de código sem as rotas que a sua chave não alcança.

Quando chamar: uma vez, ao começar a integração de leitura, e quando quiser regenerar o cliente.

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)

finalidadetexto (lista fixa)obrigatório
Valores: INTEGRACAO_TMS, CONSULTA_EMBARCADOR, CONSULTA_DESTINATARIO

Respostas

200application/yaml

OpenAPI 3.1 do grupo, em YAML

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

Status	Quando	O que fazer
`400`	Finalidade desconhecida (`detail`: "Finalidade desconhecida.")	Usar um dos três valores
`401`	Chave inválida	Conferir a chave
`403`	A chave não recebe esse OpenAPI: chave de consulta pedindo a finalidade de outro tipo, ou pedido de `ENTRADA_TRANSPORTADORA`	Pedir a finalidade da própria chave
`429`	Limite de chamadas	Esperar o `Retry-After`

Observações

a chave do TMS pode pedir qualquer uma das três finalidades. Chave de consulta só obtém a própria finalidade. Este arquivo é separado do Swagger público: ele cobre as rotas /v1/saida/**.

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

Requisição

Produção

https://api.veltrasolution.com

Teste

https://api-teste.veltrasolution.com

curl -X GET 'https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI' \
  -H 'X-Veltra-Api-Key: SUA_CHAVE_AQUI'

const resposta = await fetch("https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI", {
  method: "GET",
  headers: {
    "X-Veltra-Api-Key": "SUA_CHAVE_AQUI",
  },
});

console.log(resposta.status);
console.log(await resposta.text());

import requests

resposta = requests.request(
    "GET",
    "https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI",
    headers={
        "X-Veltra-Api-Key": "SUA_CHAVE_AQUI",
    },
    timeout=30,
)

print(resposta.status_code)
print(resposta.text)

<?php
$ch = curl_init('https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-Veltra-Api-Key: SUA_CHAVE_AQUI',
    ],
]);

$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
echo $resposta;
curl_close($ch);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Exemplo {
    public static void main(String[] args) throws Exception {
        HttpRequest requisicao = HttpRequest.newBuilder(URI.create("https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI"))
        .header("X-Veltra-Api-Key", "SUA_CHAVE_AQUI")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

        HttpResponse<String> resposta = HttpClient.newHttpClient()
            .send(requisicao, HttpResponse.BodyHandlers.ofString());

        System.out.println(resposta.statusCode());
        System.out.println(resposta.body());
    }
}

using System.Net.Http;
using System.Text;

using var cliente = new HttpClient();
var requisicao = new HttpRequestMessage(new HttpMethod("GET"), "https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI");
requisicao.Headers.Add("X-Veltra-Api-Key", "SUA_CHAVE_AQUI");

var resposta = await cliente.SendAsync(requisicao);
Console.WriteLine((int)resposta.StatusCode);
Console.WriteLine(await resposta.Content.ReadAsStringAsync());

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	requisicao, err := http.NewRequest("GET", "https://api.veltrasolution.com/v1/saida/openapi/FINALIDADE_AQUI", nil)
	if err != nil {
		panic(err)
	}
	requisicao.Header.Set("X-Veltra-Api-Key", "SUA_CHAVE_AQUI")

	resposta, err := http.DefaultClient.Do(requisicao)
	if err != nil {
		panic(err)
	}
	defer resposta.Body.Close()

	texto, _ := io.ReadAll(resposta.Body)
	fmt.Println(resposta.StatusCode)
	fmt.Println(string(texto))
}

Troque SUA_CHAVE_AQUI pela sua chave. O servidor de teste tem o mesmo comportamento do de produção.