API Reference
Everything you need to integrate AxeDz into your app. All requests require your API key and return a simple JSON response.
Base URL
All API requests go to:
https://api.axedz.com/v1Authentication
Include your API key in every request:
| Header | Required | Description |
|---|---|---|
| X-API-Key | Yes | Your API key from the dashboard |
| Content-Type | Yes (POST) | application/json |
Response format
Success
{ "success": true, "data": { }}Error
{ "success": false, "message": "Detailed error description"}See the Errors guide for a full list of error codes and how to handle them.
Send SMS
Send an SMS to any Algerian phone number. Costs 2 DZD per message in production mode.
POST /v1/sms/send { "to": "+213555123456", "message": "Your verification code is 482910"}| Field | Type | Description |
|---|---|---|
| to | string | Recipient phone number in international format (e.g. +213...) |
| message | string | The text message to send |
{ "success": true, "data": { "id": "sms_abc123", "status": "queued", "to": "+213555123456", "cost": 2 }}Send email
Send a transactional email to your customer. Costs 0.4 DZD per email in production mode.
POST /v1/email/send { "to": "user@example.com", "subject": "Welcome to AxeDz", "body": "<h1>Hello!</h1><p>Your account is ready.</p>"}| Field | Type | Description |
|---|---|---|
| to | string | Recipient email address |
| subject | string | Email subject line |
| body | string | Email content — HTML or plain text |
Contacts
Save customer contact details for future messaging campaigns.
POST /v1/contacts { "name": "Ahmed Benali", "phone": "+213555123456", "email": "ahmed@example.com", "tags": ["customer", "premium"]}GET /v1/contactsWallet
Check your current balance and account mode.
GET /v1/wallet{ "success": true, "data": { "balance": 12500, "currency": "DZD", "mode": "production" }}Message logs
Review your sent messages, delivery status, and costs.
- GET /v1/logs/sms — all SMS messages you have sent
- GET /v1/logs/email — all emails you have sent
- GET /v1/usage — summary of your usage and spending
| Field | Description |
|---|---|
| id | Unique message ID |
| status | queued, sent, delivered, or failed |
| cost | Amount charged in DZD |
| created_at | When the message was sent |
Cloud Storage (coming soon)
Coming soon
AI Tokens (coming soon)
Coming soon
Rate limits
To keep the platform fast and fair for everyone, API requests are rate limited. If you send too many requests in a short time, you will receive a 429 error. Wait a moment and try again.