Búsqueda de endpoints

Busca en la API de comprador

146 endpoints en 19 recursos. Busca por ruta, método o lo que quieras hacer: pega una URL real y sus ids coinciden con los parámetros de la ruta.

Prueba

Referencia de la API

La API de Pleaxy es una API REST con solicitudes y respuestas en JSON. Úsala para leer y crear órdenes de compra y facturas, y para seguirlas durante la aprobación y el pago. Para conceptos y guías, consulta la documentación.

Autenticación

Envía uno de estos dos encabezados en cada solicitud:

  • X-Api-Key: <keyId>.<secret>: una clave de API, para tus propios sistemas y agentes.
  • Authorization: Bearer <accessToken>: la sesión de una persona que ha iniciado sesión, necesaria para algunas acciones, como aprobar y gestionar claves de API.

Una credencial funciona en un espacio de trabajo, como comprador o como proveedor. Cada ruta incluye el id de ese espacio de trabajo como regionId; cópialo desde Perfil de la empresa → ID del espacio de trabajo en Pleaxy.

Errores

Los errores usan códigos de estado 4xx y un cuerpo JSON. Decide según code, no según el message en inglés; messageId y params te permiten mostrar el mensaje en tu propio idioma.

Versionado

Las rutas empiezan por la versión, /v1. Dentro de ella se añaden endpoints, campos y valores nuevos, así que ignora los campos que no reconozcas y ten un valor por defecto para valores desconocidos, como los estados. Los cambios incompatibles llegan como una versión nueva.

URL base
https://api.pleaxy.ai
Solicitud autenticada
curl "$PLEAXY_API_BASE_URL/v1/workspaces/$WORKSPACE_ID/purchase-orders" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Error
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Invoice INV-7F3A9C21 not found.",
  "code": "string",
  "messageId": "string",
  "params": { ... }
}

Recursos

Habla con nosotros