🚀 Getting Started

The FOL Cloud API provides the ability to perform CRUD operations on shipments, as well as access resources like shipping labels, waybills, and proof of delivery documents.

• To start using the FOL Cloud API, you will need to use your client credentials to authenticate and get a valid bearer token for your requests.

• To make a client credentials request you will be issued with a client ID and a client Secret which must be protected.

• We will also require the External IP address that you will be making calls to the API.

• Upon set up you must let us know which endpoints you would like to use and which actions we need to assign.

• Once you have been issued with these credentials, you can follow the authentication steps below to get a bearer token and start making requests to the API.

Scopes

Scope Name	Read	Create	Edit	Delete
shipment	Yes	Yes	Yes	Yes
document	Yes	No	No	No
label	Yes	No	No	No

API Endpoints

Production and Test Environment Base URI’s

Server	Base URI
Production	https://api.fairlea.cloud
Test	https://api.test.fairlea.cloud

Other things to consider

• The API has rate and usage limits. See below for details.

• The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 404 Not Found.

• The API returns request responses in JSON format.

Rate and usage limits

API access is rate limited to 100 requests per minute and 10 requests concurrently, per IP address. A 429 Too Many Requests status will be returned if the rate is exceeded.

Postman Workspace