Skip to main content

​
Getting Started — Overview

The Cartevo API is designed to be simple, predictable, and compliant with web standards. This guide will help you make your first API call in minutes.

​
API Basics

  • Architecture: RESTful
  • Data Format: JSON
  • Encoding: UTF-8
  • Base URL: https://api.cartevo.co/v1/

​
Authentication

All API requests require authentication using a Bearer Token in the HTTP Authorization header.

​
Getting your API Key

  1. Log in to your Cartevo Dashboard
  2. Navigate to Settings → API Keys
  3. Generate a new API key for your environment (Test/Production)
⚠️ Keep your API keys secure and never expose them in client-side code.
NOTE: The API key is only valid for one hour. After this time you will have to re-authenticate

​
Making your first request

Here’s a simple example to create a customer: 
POST https://api.cartevo.co/v1/customers
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "+237123456789"
}
Response: 
{
  "id": "cust_abc123",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "+237123456789",
  "created_at": "2025-10-06T10:30:00Z"
}

​
HTTP Status Codes

The API returns standard HTTP status codes to indicate the success or failure of requests:

​
Success Codes

  • 200 OK - Request succeeded
  • 201 Created - Resource created successfully

​
Client Error Codes

  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Invalid or missing API key
  • 404 Not Found - Resource not found

​
Server Error Codes

  • 500 Internal Server Error - Server error
All error responses include a JSON body with additional details: 
{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: email"
  }
}
Now that you understand the basics.