Skip to main content

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 Authorization header (see Authentication)

Making your first request

Step 1 — exchange your client_id and client_key for a short-lived access token:
POST https://api.cartevo.co/api/v1/auth/token
Content-Type: application/json

{
  "client_id": "client_abcdef123456",
  "client_key": "secret_xyz789..."
}
Response:
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}
Step 2 — use the token to call any other endpoint, e.g. listing your wallets:
GET https://api.cartevo.co/api/v1/wallets
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Tokens expire after 1 hour. There is no refresh endpoint — call POST /auth/token again when needed.

HTTP status codes (summary)

CodeMeaning
200Request succeeded
201Resource created
400Validation or business-rule error
401Missing, invalid, or expired token
403Authenticated but not authorized
404Resource not found
409Conflict (e.g. duplicate)
429Rate limit exceeded
5xxServer error — retry with exponential backoff
For full retry guidance and the standard error envelope, see API Conventions → Errors.

Next steps