OpenAPI

Toda a API é descrita em um único documento OpenAPI 3.1:

https://tradecatalog.app/api/v1/openapi.json

É público (não é necessário chave) e gerado a partir das mesmas estruturas que a API usa para verificar as requisições, então ele não pode se afastar do que a API aceita. Ele inclui todos os caminhos, parâmetros, corpo da requisição, limites e valores de enumeração.

Importar para Postman ou InsomniaLink para esta seção#

1. No Postman, escolha Importar e cole a URL acima. No Insomnia, escolha Importar e depois De URL.
2. Defina a autenticação da coleção como Token de Portador com sua chave de API.

Gerar tipos TypeScriptLink para esta seção#

openapi-typescript os converte em tipos:

npx openapi-typescript https://tradecatalog.app/api/v1/openapi.json -o tradecatalog.d.ts

Use-os com openapi-fetch para um cliente tipado:

import createClient from 'openapi-fetch'

const client = createClient({
  baseUrl: 'https://tradecatalog.app/api/v1',
  headers: { Authorization: `Bearer ${process.env.TRADECATALOG_API_KEY}` },
})

const { data, error } = await client.GET('/prices', {
  params: { query: { customer: 'OAK01', sku: 'HX-8510', qty: 10 } },
})

O documento descreve parâmetros e corpos de solicitação em detalhes. Os corpos de resposta são descritos como o envelope compartilhado { data, nextOffset, currency }; as formas de resposta por campo estão na página de cada ponto final neste documento.

Outras linguagensLink para esta seção#

Qualquer gerador OpenAPI funciona, por exemplo:

npx @openapitools/openapi-generator-cli generate \
  -i https://tradecatalog.app/api/v1/openapi.json \
  -g python -o tradecatalog-client

Navegue por eleLink para esta seção#

Cole a URL no Scalar, Swagger Editor ou qualquer visualizador OpenAPI para navegar pelos pontos finais e testar solicitações com sua chave.

Para agentes de IALink para esta seção#

O documento OpenAPI está listado no catálogo de API em /.well-known/api-catalog, então os agentes podem encontrá-lo por conta própria. Veja Recursos de IA e LLM.