Areye Developer API — Documentation

Authentication

The Areye Business API uses API key authentication. Include your key in the X-Business-API-Key header on every request. You can find and rotate your key in the Business Portal under Settings → API Access.

Request Header

X-Business-API-Key: biz_live_xxxxxxxxxxxxxxxxxxxxxxxx

Keep your API key secret. Never expose it in client-side code or public repositories. Use environment variables. Rotate your key immediately from the Business Portal if you suspect it has been compromised.

Rate Limits

Plan	Requests / min	Requests / day
Starter	30	1,000
Business	120	10,000
Enterprise	Custom	Custom

Rate limit headers are returned on every response: X-RateLimit-Remaining and X-RateLimit-Reset.

Endpoints

Bookings

POST /business/book Book a ride or delivery on behalf of an employee or guest

GET /business/trips List all trips with filters (date range, employee, status, service type)

GET /business/trips/{id} Retrieve a single trip with receipt and route details

POST /business/trips/{id}/cancel Cancel a trip before driver assignment (full refund to wallet)

People & Groups

GET /business/people List all employees and their spending limits

POST /business/people Add an employee to your business account

PATCH /business/people/{id} Update employee details or spending limit

DELETE /business/people/{id} Remove an employee from your account

Wallet

GET /business/wallet Get current wallet balance and recent transactions

POST /business/wallet/topup Initiate a wallet top-up via EFT or card

Billing

GET /business/billing/statements List all monthly statements

GET /business/billing/statements/{id} Retrieve a statement (PDF download link included)

Coupons

GET /business/coupons List all employee discount coupons

POST /business/coupons Issue a new coupon to one or more employees

DELETE /business/coupons/{id} Revoke a coupon

Account

GET /business/profile Retrieve your business account profile and settings

PATCH /business/profile Update company name, billing contact, or webhook URL

POST /business/api-key Rotate your API key (previous key invalidated immediately)

Example: Book a parcel delivery for an employee

POST /business/book

curl -X POST https://api.areye.app/business/book \
  -H "X-Business-API-Key: biz_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "delivery",
    "employee_id": "EMP-0042",
    "expense_code": "PROJ-2026-Q3",
    "pickup": {
      "address": "Plot 64271, Block 3 Industrial, Gaborone",
      "contact_name": "John Smith",
      "contact_phone": "+267712345678"
    },
    "dropoff": {
      "address": "Molapo Crossing Mall, Gaborone",
      "contact_name": "Jane Doe",
      "contact_phone": "+267723456789"
    },
    "package": {
      "size": "standard",
      "weight_kg": 2.5,
      "fragile": false,
      "description": "Electronics - handle with care"
    },
    "scheduled_at": null,
    "notify_recipient": true
  }'

201 Created — Response

{
  "id": "BK-28491",
  "status": "pending",
  "service": "delivery",
  "employee_id": "EMP-0042",
  "expense_code": "PROJ-2026-Q3",
  "quote": {
    "amount": 85.00,
    "currency": "BWP",
    "distance_km": 4.2
  },
  "estimated_pickup_at": "2026-07-01T14:15:00Z",
  "tracking_url": "https://areye.app/track/BK-28491",
  "created_at": "2026-07-01T14:08:32Z"
}

Webhooks

Set your webhook URL in Business Portal → Settings → API Access. Areye signs all payloads — verify the X-Areye-Signature header before processing to ensure the event originated from Areye.

Event	Description
`trip.created`	A trip was booked via the API or Business Portal
`trip.driver_accepted`	A driver was matched and accepted the trip
`trip.picked_up`	Driver picked up the passenger or parcel
`trip.completed`	Trip completed — receipt and route data available
`trip.cancelled`	Trip was cancelled — includes refund status
`wallet.low_balance`	Wallet balance fell below your configured threshold
`invoice.issued`	A new monthly invoice is ready for download

Errors

Areye uses standard HTTP status codes. All error responses include a machine-readable code field and a human-readable message.

Status	Meaning
200	Success
201	Created — resource was successfully created
401	Unauthorized — missing or invalid API key
403	Forbidden — your plan does not include this endpoint or feature
404	Not Found — resource does not exist
422	Unprocessable — validation failed, insufficient wallet balance, or credit limit exceeded
429	Too Many Requests — rate limit exceeded
500	Internal Server Error — contact support

SDKs & Libraries

Official SDKs are under development. In the meantime, use the REST API directly with your preferred HTTP client.

JavaScript / Node.js

Coming Q3 2026

Python