Pleaxy

Emita pedidos de compra, aprove e pague faturas, e configure seu espaço de trabalho.

Busca de endpoints

Busque na API do comprador

146 endpoints em 19 recursos. Busque por caminho, método ou pelo que você quer fazer: cole uma URL real e os ids dela correspondem aos parâmetros do caminho.

Experimente

Referência da API

A API da Pleaxy é uma API REST com requisições e respostas em JSON. Use-a para ler e criar pedidos de compra e faturas, e para acompanhá-los na aprovação e no pagamento. Para conceitos e guias, veja a documentação.

Autenticação

Envie um destes dois cabeçalhos em cada requisição:

  • X-Api-Key: <keyId>.<secret>: uma chave de API, para seus próprios sistemas e agentes.
  • Authorization: Bearer <accessToken>: a sessão de uma pessoa conectada, exigida em algumas ações, como aprovar e gerenciar chaves de API.

Uma credencial funciona em um espaço de trabalho, como comprador ou fornecedor. Todo caminho inclui o id desse espaço de trabalho como regionId; copie-o em Perfil da empresa → ID do espaço de trabalho na Pleaxy.

Erros

Os erros usam códigos de status 4xx e um corpo JSON. Decida pelo code, não pela message em inglês; messageId e params permitem mostrar a mensagem no seu idioma.

Versionamento

Os caminhos começam pela versão, /v1. Novos endpoints, campos e valores são adicionados dentro dela, então ignore campos que você não reconhece e tenha um padrão para valores desconhecidos, como status. Mudanças incompatíveis vêm como uma nova versão.

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

Recursos

Fale conosco