Skip to content

Getting Started

Step 1: Onboarding

Contact the Academia team to register as an API partner. You will receive:

  • A username and password for API authentication
  • A configured daily spending limit (in LYD)

Step 2: IP Whitelisting

Provide your production server IP address(es) to the Academia team. All API endpoints --- including authentication --- are restricted to whitelisted IPs only.

WARNING

You cannot make any API calls until at least one IP address is whitelisted. Requests from non-whitelisted IPs receive a 403 Forbidden response.

Step 3: Obtain a Token

Use your credentials to request a bearer token:

bash
curl -X POST https://api.academia.ly/api/v1/reseller/token \
  -H "Content-Type: application/json" \
  -d '{
    "username": "your_username",
    "password": "your_password",
    "expires_at": "2026-05-01T00:00:00Z"
  }'

Response:

json
{
  "data": {
    "token": "1|abc123...",
    "expires_at": "2026-05-01T00:00:00Z"
  }
}

Step 4: Make API Calls

Include the token in the Authorization header for all subsequent requests:

bash
curl -X GET https://api.academia.ly/api/v1/reseller/denominations \
  -H "Authorization: Bearer 1|abc123..."

Quick Reference

EndpointMethodPurpose
/tokenPOSTObtain authentication token
/denominationsGETList available denominations
/vouchers/generatePOSTGenerate a voucher code
/user-lookupGETLook up user by phone number
/depositPOSTDeposit funds to user wallet

TIP

All endpoints are prefixed with https://api.academia.ly/api/v1/reseller

Academia API Integration Documentation