OpenAPI

De hele API is beschreven in één OpenAPI 3.1 document:

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

Het is openbaar (geen sleutel nodig) en gegenereerd vanuit dezelfde schema’s die de API gebruikt om aanvragen te controleren, dus het kan niet afwijken van wat de API accepteert. Het bevat elk pad, elk parameter, elk aanvraagbody, elke limiet en elke enum-waarde.

Importeren in Postman of InsomniaLink naar deze sectie#

1. Kies in Postman Import en plak de URL hierboven. Kies in Insomnia Import en daarna From URL.
2. Stel de verificatie van de verzameling in op Bearer Token met uw API-sleutel.

Genereer TypeScript typenLink naar deze sectie#

openapi-typescript zet het om in typen:

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

Gebruik ze met openapi-fetch voor een getypeerde client:

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 } },
})

Het document beschrijft aanvraagparameters en -body's volledig. Response bodies worden beschreven als het gedeelde { data, nextOffset, currency } envelop; de veld-voor-veld response vormen zijn op elke eindpuntpagina in deze documentatie.

Andere talenLink naar deze sectie#

Elke OpenAPI generator werkt, bijvoorbeeld:

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

Blader erinLink naar deze sectie#

Plak de URL in Scalar, Swagger Editor of een willekeurige OpenAPI viewer om de eindpunten te bladeren en aanvragen te testen met uw sleutel.

Voor AI-agentsLink naar deze sectie#

Het OpenAPI-document is vermeld in de API-catalogus op /.well-known/api-catalog, zodat agents het zelf kunnen vinden. Zie AI- en LLM-resources.