Quickstart
Get up and running in minutes. Create your account, grab an API key, and send your first SMS or email.
1. Create your account
Sign up for free at the dashboard. Verify your email or phone number, and you will start in sandbox mode — a free testing environment where no real messages are sent and nothing is charged.
2. Create an API key
In your dashboard, create a project and generate an API key. You will use this key to authenticate every request you send to AxeDz.
- Each project can have its own API key
- You can revoke a key at any time if it is compromised
- Include your key in the X-API-Key header with every request
3. Install the SDK (optional)
Our SDKs make integration easier by handling authentication and errors for you. You can also use cURL or any HTTP client if you prefer.
Node.js
npm install axedzPython
pip install axedzSee the SDK guide for complete examples.
4. Send your first SMS
Using cURL
curl -X POST https://api.axedz.com/v1/sms/send \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ -d '{ "to": "+213555123456", "message": "Hello from AxeDz!" }'Using the Node.js SDK
const AxeDz = require("axedz"); const client = new AxeDz("YOUR_API_KEY"); const result = await client.sms.send({ to: "+213555123456", message: "Hello from AxeDz!",}); console.log(result);5. Send your first email
curl -X POST https://api.axedz.com/v1/email/send \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ -d '{ "to": "user@example.com", "subject": "Welcome to AxeDz", "body": "Your account is ready." }'6. Go live
When you are ready to send real messages, top up your wallet through SATIM in the dashboard, then switch your project from sandbox to production mode.
Sandbox vs production
Understanding responses
Every API response follows the same format:
{ "success": true, "data": { "id": "msg_abc123", "status": "queued" }}If something goes wrong, you will get success: false with a clear message explaining what happened. See the Errors guide for details.