Getting Started with Yojee API Integration

A step-by-step guide to integrate Yojee’s RESTful API for order creation, milestone retrieval, and seamless logistics management.

Overview

The Yojee API allows developers to integrate seamlessly with Yojee’s logistics platform. Use the API for programmatic order creation, milestone tracking, and data retrieval to automate your logistics workflows.

This guide provides the key steps to get started with the Yojee API and highlights essential components, including base URLs, authentication, and code samples.

1. Yojee API Documentation

To explore the full API capabilities, visit the Yojee API Documentation.

2. Base URL

The Yojee API is served over HTTPS. All endpoints referenced in this guide use the following base URL:

https://umbrella.yojee.com/

3. Authentication

To interact with the Yojee API, you need an ACCESS_TOKEN for secure authentication.

Steps to Authenticate:

Ensure you have a valid Yojee account or access token.
If you do not have access, contact support@yojee.com to request credentials.
Use the Authentication API to authenticate a user and retrieve the access token.
Include the token in the Authorization header for all subsequent requests.

Example Header:

Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

4. Order Creation and Milestone Tracking

The following APIs provide programmatic access to key logistics operations in Yojee:

Order Creation: Automate order creation directly from your systems.
Milestone Retrieval (via Webhooks): Track order progress and key milestones in real-time.

Refer to the Yojee API Documentation for detailed specifications and endpoint usage.

5. Code Samples

Each API endpoint includes sample code snippets in two common formats:

HTTP Requests
cURL Commands

Ensure all requests include the following:

Content-Type: application/json

Example cURL Command:

curl --request POST \
  --url https://umbrella.yojee.com/orders \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
    "order_details": {
      "customer_name": "Example Co.",
      "pickup_location": "123 Example Street",
      "dropoff_location": "456 Destination Road"
    }
  }'

6. API Best Practices

To prevent flooding Yojee servers and ensure smooth API interactions, follow these best practices:

Throttle Requests: Limit API call frequency to avoid overloading the service.
Retry Strategy: Implement exponential back-off for failed requests.
Monitor Usage: Regularly review API call volumes to maintain efficient integration.

7. Next Steps

Review the Yojee API Documentation for detailed endpoint specifications.
Contact Yojee Support for access or additional guidance.
Begin integrating and automating your logistics workflows today!