Client Portal API

In this article, you will learn about Onfleet's RESTful API and how to create an API key in your Client Portal. The Onfleet API is a RESTful web service for developers to create and manage orders programmatically. To learn more about using the Onfleet API to create Order Endpoints, please visit the Onfleet API documentation center

All requests must be authenticated using an API key from the Client Portal. You can create and maintain API keys through the "API & Integrations" tab in their dashboard settings. 

This article will cover:

Add an API Key

To add an API key, log into your Client Portal account and then select the "Settings" icon on the dashboard's upper right corner.

Once you are in the "Settings" window, select the "API & Integrations" category. 

You can now select the "+" symbol at the bottom right corner to create an API key registered with your organization, and select "Create Key".

Return to Top

Access an API Key

To access an API Key that has been created, you can go to the "API & Integrations" section in the "Settings" window.

Once there, select the key you would like to view and select "Edit" to view the API key and be able to copy it if necessary.

Return to Top

Delete an API Key

To delete an API key, you can access the key in the "API & Integrations" section, select the key you would like to delete then select the "-" button located on the bottom right of the window.


Return to Top