Ricerca endpoint

Cerca nell’API acquirente

146 endpoint in 19 risorse. Cerca per percorso, metodo o ciò che vuoi fare: incolla un URL reale e i suoi id corrispondono ai parametri del percorso.

Prova

Riferimento API

L’API di Pleaxy è un’API REST con richieste e risposte in JSON. Usala per leggere e creare ordini d’acquisto e fatture e per seguirli lungo l’approvazione e il pagamento. Per concetti e guide, consulta la documentazione.

Autenticazione

Invia uno di questi due header con ogni richiesta:

  • X-Api-Key: <keyId>.<secret>: una chiave API, per i tuoi sistemi e agenti.
  • Authorization: Bearer <accessToken>: la sessione di una persona che ha effettuato l’accesso, richiesta per alcune azioni come approvare e gestire le chiavi API.

Una credenziale funziona in un solo spazio di lavoro, come acquirente o come fornitore. Ogni percorso include l’id di quello spazio di lavoro come regionId; copialo in Pleaxy da Profilo aziendale → ID spazio di lavoro.

Errori

Gli errori usano codici di stato 4xx e un corpo JSON. Basa la logica su code, non sul message in inglese; messageId e params ti permettono di mostrare il messaggio nella tua lingua.

Versioni

I percorsi iniziano con la versione, /v1. Al suo interno si aggiungono nuovi endpoint, campi e valori, quindi ignora i campi che non riconosci e prevedi un valore predefinito per i valori sconosciuti, come gli stati. Le modifiche incompatibili arrivano con una nuova versione.

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

Risorse

Contattaci