Getting Started — Overview
The Cartevo API is designed to be simple, predictable, and standards-compliant. This guide gets you to your first successful call in under five minutes. For the conventions that apply across every endpoint (response envelope, error shape, money/date formats, pagination, idempotency, rate limits), see API Conventions.API basics
- Architecture: RESTful, JSON-based
- Encoding: UTF-8
- Base URL:
https://api.cartevo.co/api/v1 - Authentication: Bearer token in the
Authorizationheader (see Authentication)
Making your first request
Step 1 — exchange yourclient_id and client_key for a short-lived access token:
POST /auth/token again when needed.
HTTP status codes (summary)
| Code | Meaning |
|---|---|
200 | Request succeeded |
201 | Resource created |
400 | Validation or business-rule error |
401 | Missing, invalid, or expired token |
403 | Authenticated but not authorized |
404 | Resource not found |
409 | Conflict (e.g. duplicate) |
429 | Rate limit exceeded |
5xx | Server error — retry with exponential backoff |
Next steps
- API Conventions — the cross-cutting rules every endpoint follows.
- Authentication — token lifetime, scope, and security.
- Environments — preproduction vs. production limits.
- Webhooks — receive events asynchronously instead of polling.