OpenAPI

L'intera API è descritta in un documento OpenAPI 3.1:

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

È pubblico (non è necessaria una chiave) e generato dagli stessi schemi utilizzati dall'API per verificare le richieste, quindi non si allontana da ciò che l'API accetta. Include ogni percorso, parametro, corpo della richiesta, limite e valore enum.

Importa in Postman o InsomniaCollegamento a questa sezione#

1. In Postman, scegliere Importa e incollare l'URL sopra. In Insomnia, scegliere Importa quindi Da URL.
2. Impostare l'autenticazione della raccolta su Token Bearer con la tua chiave API.

Genera tipi TypeScriptCollegamento a questa sezione#

openapi-typescript li converte in tipi:

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

Utilizzali con openapi-fetch per un client tipizzato:

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

Il documento descrive i parametri e i corpi delle richieste in modo completo. I corpi delle risposte sono descritti come l'envelope condiviso { data, nextOffset, currency }; le forme dei campi delle risposte sono disponibili nella pagina di ogni endpoint in questi documenti.

Altri linguaggiCollegamento a questa sezione#

Qualsiasi generatore OpenAPI funziona, ad esempio:

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

EsploraloCollegamento a questa sezione#

Incolla l'URL in Scalar, Swagger Editor o qualsiasi visualizzatore OpenAPI per esplorare gli endpoint e provare le richieste con la tua chiave.

Per gli agenti di intelligenza artificialeCollegamento a questa sezione#

Il documento OpenAPI è elencato nel catalogo API su /.well-known/api-catalog, quindi gli agenti possono trovarlo da soli. Vedere risorse per l'IA e i modelli linguistici.