API Overview

The Safaribid API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URLs

Authentication

Authentication is handled via Bearer Tokens. You can generate your API keys in the Developer Settings section of your dashboard.

Authorization: Bearer YOUR_API_KEY

Request Lifecycle

1. Authentication: Client sends a request with a valid API key.
2. Validation: Safaribid validates the request payload and permissions.
3. Processing: The internal engine (Logistics, Commerce, or Mobility) processes the request.
4. Fulfillment: If applicable (e.g., a delivery), a rider is dispatched.
5. Response: A JSON response is returned with the status and resource data.

Core API Collections

• Logistics API: Delivery quotes, requests, and tracking.
• Merchant API: Product, inventory, and order management.
• Mobility API: Ride hailing and fleet management.
• Wallet API: Balance checks and payouts.

Webhooks

We use webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like:

• delivery.rider_assigned
• delivery.completed
• order.paid

Learn more about Webhooks.