Referência
Tudo o que a API pública da Pitra expõe, em uma página.
OpenAPI
A especificação OpenAPI 3.1 é gerada a partir da própria API e está sempre atualizada.
Baixar OpenAPI JSONURL: /api/public/v1/openapi.json — importe em Postman, Insomnia ou geradores de SDK.
Endpoints e scopes
Base: https://pitra.com.br/api/public/v1
| Método | Caminho | Scope |
|---|---|---|
| GET | /products | products:read |
| POST | /products | products:write |
| GET | /products/{id} | products:read |
| PATCH | /products/{id} | products:write |
| POST | /products/{id}/archive | products:write |
| GET | /checkouts | checkouts:read |
| POST | /checkouts | checkouts:write |
| GET | /checkouts/{id} | checkouts:read |
| POST | /checkouts/{id}/archive | checkouts:write |
| GET | /sales | sales:read |
| GET | /sales/{id} | sales:read |
| GET | /webhooks | webhooks:read |
| POST | /webhooks | webhooks:manage |
| GET | /webhooks/{id} | webhooks:read |
| PATCH | /webhooks/{id} | webhooks:manage |
| DELETE | /webhooks/{id} | webhooks:manage |
| POST | /webhooks/{id}/test | webhooks:manage |
| GET | /webhooks/{id}/deliveries | webhooks:read |
Códigos de erro
| Código | HTTP |
|---|---|
invalid_request | 400 |
authentication_required | 401 |
invalid_api_key | 401 |
expired_api_key | 401 |
revoked_api_key | 401 |
insufficient_scope | 403 |
not_found | 404 |
idempotency_conflict | 409 |
rate_limited | 429 |
internal_error | 500 |
Vendas também respondem 405 method_not_allowed a verbos de escrita.
Scopes
| Scope | Permite |
|---|---|
| products:read | Ler produtos. |
| products:write | Criar, atualizar e arquivar produtos. |
| checkouts:read | Ler checkouts. |
| checkouts:write | Criar e arquivar checkouts. |
| sales:read | Ler vendas. |
| customers:read | Reservado. Nenhum endpoint público exige este scope hoje. |
| webhooks:read | Ler endpoints e histórico de entregas. |
| webhooks:manage | Criar, atualizar, remover e testar endpoints. |