OpenAPI

Die gesamte API wird in einem einzigen OpenAPI 3.1-Dokument beschrieben:

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

Sie ist öffentlich (kein Schlüssel erforderlich) und wird aus denselben Schemas generiert, die die API verwendet, um Anfragen zu überprüfen, sodass sie nicht von dem abweichen kann, was die API akzeptiert. Sie enthält jeden Pfad, jeden Parameter, jede Anfragekörper, jede Begrenzung und jeden Enum-Wert.

In Postman oder Insomnia importierenLink zu diesem Abschnitt#

1. Wählen Sie in Postman Importieren und fügen Sie die oben stehende URL ein. Wählen Sie in Insomnia Importieren und dann Aus URL.
2. Legen Sie die Authentifizierung der Sammlung auf Bearer Token mit Ihrem API-Schlüssel fest.

TypeScript-Typen generierenLink zu diesem Abschnitt#

openapi-typescript konvertiert es in Typen:

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

Verwenden Sie sie mit openapi-fetch für einen typisierten 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 } },
})

Das Dokument beschreibt Anforderungsparameter und -texte im Detail. Antworttexte werden als gemeinsamer { data, nextOffset, currency }-Umschlag beschrieben; die feldweise Antwortformate sind auf der Seite jedes Endpunkts in diesen Dokumenten.

Andere SprachenLink zu diesem Abschnitt#

Jeder OpenAPI-Generator funktioniert, z. B.:

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

Durchsuchen Sie esLink zu diesem Abschnitt#

Fügen Sie die URL in Scalar, Swagger Editor oder einen beliebigen OpenAPI-Betrachter ein, um die Endpunkte zu durchsuchen und Anfragen mit Ihrem Schlüssel zu testen.

Für KI-AgentenLink zu diesem Abschnitt#

Das OpenAPI-Dokument ist in der API-Katalogliste unter /.well-known/api-catalog aufgeführt, sodass Agenten es selbst finden können. Siehe AI- und LLM-Ressourcen.