La totalidad de la API se describe en un único documento OpenAPI 3.1:
https://tradecatalog.app/api/v1/openapi.json
Es público (no se necesita clave) y se genera a partir de los mismos esquemas que utiliza la API para verificar las solicitudes, por lo que no se desfasará de lo que acepta la API. Incluye cada ruta, parámetro, cuerpo de solicitud, límite y valor de enumeración.
Importar en Postman o InsomniaEnlace a esta sección#
- En Postman, elija Importar y pegue la URL anterior. En Insomnia, elija Importar y luego Desde URL.
- Establezca la autenticación de la colección en Token de portador con su clave de API.
Generar tipos de TypeScriptEnlace a esta sección#
openapi-typescript los convierte en tipos:
npx openapi-typescript https://tradecatalog.app/api/v1/openapi.json -o tradecatalog.d.ts
Luego use los tipos con openapi-fetch para un 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 } },
})
El documento describe parámetros y cuerpos de solicitud en detalle. Los cuerpos de respuesta se describen como el sobre compartido { data, nextOffset, currency }; las formas de respuesta por campo están en la página de cada punto final en estos documentos.
Otros lenguajesEnlace a esta sección#
Cualquier generador de OpenAPI funciona, por ejemplo:
npx @openapitools/openapi-generator-cli generate \
-i https://tradecatalog.app/api/v1/openapi.json \
-g python -o tradecatalog-client
NavegarloEnlace a esta sección#
Pegue la URL en Scalar, Swagger Editor o cualquier visualizador de OpenAPI para navegar los puntos finales y probar solicitudes con su clave.
Para agentes de IAEnlace a esta sección#
El documento OpenAPI está listado en el catálogo de API en /.well-known/api-catalog, por lo que los agentes pueden encontrarlo por sí mismos. Vea Recursos de IA y LLM.