La API REST le da a sus sistemas propios los mismos datos que ven sus empleados en TradeCatalog: productos, precios de clientes, clientes, pedidos, cambios de precios y el registro de actividad. Utiliza JSON sobre HTTPS y una clave de API por sistema.
URL baseEnlace a esta sección#
https://tradecatalog.app/api/v1
Cada solicitud necesita una clave de API en el encabezado Authorization. Vea Autenticación.
¿Quién puede usarloEnlace a esta sección#
- Los propietarios y administradores crean y revocan claves. Otro personal y compradores no pueden.
- El espacio de trabajo necesita una entitlement Pro o una cuenta de piloto para crear claves.
- Los espacios de trabajo de demo no pueden usar la API en absoluto.
- Cuando finaliza el Pro, el espacio de trabajo vuelve a Free: las claves de API existentes aún pueden leer, pero no pueden escribir. Las ediciones del catálogo y los pedidos de compradores en la aplicación siguen funcionando.
Una clave pertenece a un espacio de trabajo. Actúa con los permisos de la persona que la creó, por lo tanto, una clave de un propietario o administrador puede ver los precios de todos los clientes. Si esa persona deja el espacio de trabajo, la clave deja de funcionar.
Puntos finalesEnlace a esta sección#
| Método | Ruta | Qué hace | Alcance |
|---|---|---|---|
| GET | /workspace | El espacio de trabajo al que pertenece esta clave | lectura |
| GET | /products | Lista o busca productos, opcionalmente a los precios de un cliente | lectura |
| GET | /products/{id} | Un producto con su precio | lectura |
| PUT | /products | Crea o actualiza hasta 100 productos por SKU | escritura |
| GET | /brands | Todos los marcas | lectura |
| GET | /categories | Todas las categorías | lectura |
| GET | /prices | Lo que un cliente paga por un SKU, y por qué | lectura |
| GET | /customers | Clientes comerciales | lectura |
| GET | /customers/{id} | Los términos, reglas, precios acordados y compradores de un cliente | lectura |
| PUT | /customers | Crea o actualiza hasta 100 clientes | escritura |
| GET | /orders | Últimos pedidos, desde el más reciente | lectura |
| GET | /orders/{id} | Un pedido con líneas y historial de estado | lectura |
| PATCH | /orders/{id} | Mover un pedido adelante | escritura |
| GET | /price-changes | Cambios de precios, desde el más reciente | lectura |
| GET | /price-changes/{id} | Vista previa de un cambio de precio | lectura |
| GET | /activity | Quién cambió qué | lectura |
La descripción completa y máquina legible está en /api/v1/openapi.json.
Antes de construirEnlace a esta sección#
- Lea Convenciones sobre dinero, paginación, fechas y cómo funciona
PUT. - Lea Errores sobre códigos de estado y reintentos.
- Mantenga las claves en su servidor. La API no permite solicitudes de navegador (CORS).
Aún no en la APIEnlace a esta sección#
- Webhooks: use
GET /orders?status=newen su lugar. - Publicar, programar o cancelar cambios de precios: hágalo en la aplicación.
- Reglas de descuento y precios acordados: léalos con
GET /customers/{id}, cámbielos en la aplicación. - Eliminar productos o clientes, cargar imágenes directamente, invitar a compradores, realizar pedidos como comprador.