BASIC KNOWLEDGE ABOUT API
API (application programming interface) allows clients to integrate FMS with their systems, pull and push data about various entities. The client makes HTTP requests to the system, providing information about the intended action.
If a client is asking about integration with their internal or partners' systems – you can suggest existing API functionality. The main source of information about API (can be shared with clients): https://www.fmsdocumentation.com/apis/
How to create an API?A. For a fleet.
To create an API key for all objects in fleet (all objects in account), you need to log into TrustTrack Web-User (Administrator) which is asking for API integration.
Press the button "Account settings" at the right corner:
3. Choose API key settings and create New API key:
4. Set a name for the API key and after that, copy that API key and provide it to your client/partner for further implementation according to the shared documentation.
Note: If 3rd party (partner or others) is asking about API-key for one of existing Ruptela clients, they should provide a document (agreement) signed with a client. Otherwise, we cannot provide API-key.B. Limited objects from a fleet.
Sometimes, it needs to provide an API key only for several vehicles from the fleet. At this point for algorithm added several additional steps.
Create a new web user through the LCM under the client’s name. What credentials you’ll set – it doesn’t matter. This web user should be created and used for internal-only.
Note: User type should be USER, not Administrator. Also, it can be created already, double-check all client's web-users. Try to find the name with API. And use it for further steps.Log in to the Administrator and create a new group of vehicles in Fleet Status.
Add to the created group vehicles, that should be shared in API.
Assign created the group to the API Web User (from the 1st point) and enable API key access.
After this step, web user (API User) should see only vehicles which added to the group. If you add or discard vehicles from the group – these changes also will be applied for the web user and number of the visible objects via API accordingly.
Log in via User, which was created in 1st
Create API key under User and share it via client.
In this case, the quantity of objects which is visible for User and via API is regulated by the number of objects in TrustTrack group under Administrator (created in 3rd point).
In case, if a client asking for object ID for API requests, you can easily provide it via this link:
After sign «=» you need to insert created API key and press Enter in the search bar in your browser. Copy IDs from the reply of the command. Or send to the client link for instruction how to get IDs:
In the end, provide to the client (partners):
API documentation - https://www.fmsdocumentation.com/apis/
API key (for all objects option A or for limited option B).