1. Help Center
  2. API documentation

Getting Started with Yojee API

The high level guide to Yojee API integration

Order Creation Workflow

 Our API enables you to integrate the Yojee Software with your website or a third-party by utilising RESTful API. This document provides information about a handpicked set of Yojee APIs that give programmatic access to order creationprocessingas well as seamless trace of order item status in Yojee's Dispatch System. Want to know more? Please visit https://api-docs.yojee.com/

Base URL

The Authentication API is served over HTTPS. All URLs referenced in the documentation have the following base: https://umbrella.yojee.com/

Code Samples

For each endpoint you will find sample snippets you can use, in two available formats:

  • HTTP request
  • cURL command

Each request should be sent with a Content-Type of application/json.

Authentication

Before you begin, make sure you have a valid Yojee account or the ACCESS_TOKEN. If you do not obtain a Yojee account or access token, please request one by emailing support@yojee.com.

The authentication API enables you to manage all aspects of user identity and retrieve relevant dispatcher and sender info. In the following scenario, you retrieve the access token when you authenticate a user, and then you can make a request to other endpoints using that token in the authorisation header, in order to create stuff.

IMPORTANT NOTES:

Please note that any API client needs to follow best practices to prevent flooding of Yojee servers with API requests. The service might reject API requests due to abuse otherwise. To prevent such API abuse, you can consider the following actions to regulate the calls:

  • Reduce the frequency of API requests
  • Apply a throttle to API requests
  • Implement a retry strategy like exponential back-off mechanism