AxeDz

v1.0

  • Overview
  • Quickstart
  • SDK
  • Authentication
  • Payment
  • API Reference
  • Errors

Authentication

Learn how to sign in to your dashboard and how to authenticate API requests using your API key.

Signing in to your dashboard

Access your AxeDz account through the dashboard using your email and password, or sign in quickly with your Google account. Your session stays secure and you can sign out at any time.

  • Sign up with email and password
  • Sign in with Google for faster access
  • Verify your phone or email with a one-time code (OTP)
  • Reset your password if you forget it

Using your API key

To send SMS or email through the API, you need an API key. Create one from your dashboard under Projects. Each key is tied to a project and your wallet balance.

What you need to knowDetails
Where to find itDashboard → Projects → API Keys
How to use itAdd it to the X-API-Key header on every request
If it is compromisedRevoke it immediately and create a new one
StatusActive keys work; revoked keys are blocked instantly

Example request header

HTTP
X-API-Key: 550e8400-e29b-41d4-a716-446655440000

Keep your key safe

Never share your API key publicly or embed it in mobile apps or frontend code. If you think your key has been exposed, revoke it from the dashboard right away and create a new one.

Managing your API keys

  • Create — generate a new key for each project or environment
  • Use — include the key in the X-API-Key header with every API call
  • Revoke — disable a key instantly if it is no longer needed or was exposed
  • Rotate — create a new key, update your app, then revoke the old one

Sandbox and production modes

Every project runs in either sandbox or production mode. This controls whether messages are actually sent and whether your wallet is charged.

ModeWhat happens
SandboxFree testing — messages are simulated, nothing is charged
ProductionLive sending — real messages are delivered and your wallet is charged

Switch between modes anytime from your dashboard. We recommend testing thoroughly in sandbox before going live.

Account verification (OTP)

When you sign up, we send a one-time code to your phone or email to confirm your identity. You may also be asked to verify your identity for sensitive account actions.

  • A code is sent to your phone via SMS or to your email
  • Enter the code within the time limit to verify your account
  • If you do not receive the code, you can request a new one