FOTA WEB Getting Started API: Difference between revisions

(14 intermediate revisions by 3 users not shown)

Line 3:

=='''API introduction'''==

FOTA WEB API allows ~~use of~~ system functions in your own application. If you have a user in FOTA WEB ~~then~~ you ~~already~~ have API ~~access~~!

The FOTA WEB API allows you to integrate system functions into your own application. If you already have a user account in FOTA WEB, you automatically have access to the API! What can you do with the API? You can implement any feature available in our WEB UI, and even more, into your own application. For example, if you have fleet management software and want to create configuration updates, you can! If you need to set firmware updates, you can also do that!

What can I do with the API? You can implement any feature ~~and even more from what is~~ available in our WEB UI into your own. If you have ~~your~~ fleet management software and want to create configuration ~~update from it~~, you can! If ~~want~~ to set firmware updates, you can!

=='''Getting Started API'''==

Line 16:

Line 15:

=='''Creating API token'''==

'''Step 1.''' To create token Login to '''https://fota.teltonika.lt'''

'''Step 2.''' Go to the top right corner and find '''API Tokens''' in the '''Settings'''.

[[Image:FOTA WEB settings 5.png|300px|left]]

'''Step 3.''' Next, click the '''Add Token''' button.

[[File:API tokens1.png|thumb|left]]

'''Step 4.''' Choose '''Token type>>API integration token''', write '''Token name''', and press '''Generate''' button.

[[Image:Generate API tokens.png|300px|left]]

'''Step 2.''' ~~Go to settings at top right corner~~ and ~~find '''~~API ~~Tokens''' settings~~.

[[~~Image~~:~~Settings_API~~.png|~~300px~~|~~center~~]]

'''Step 5.''' After the token is generated, copy it by clicking the copy button or by manually selecting and copying it.

[[Image:Generated API token.png|

[[File:Generated API token.png|thumb]]550|left]]

'''Important!''' After you close the window you will not be able to check Token again. For security, the Token is not saved to the system. If you lose your token or delete an existing one, you will have to create a new one.

=='''FOTA Web API changelog'''==

Here is information on the latest changes to the FOTA Web API

=== 2025-09-24 ===

All "role" properties were removed from API requests and responses.

=== 2025-07-02 ===

POST /tasks/bulkCancel endpoint changes:

* POST /tasks/bulkCancel endpoint no longer accepts "id" filter in the "filter" type source requests. Instead, "id_list" source should be used and provide a list of task IDs.

~~'''Step 3.''' Write name for the '''New token''' and press '''Create.'''~~

GET /tasks endpoint changes:

~~[[Image~~:~~API_tokens_3.png|550px|center]]~~

~~'''Step 4.''' Press on~~ the ~~Token to copy or select it and copy manually~~.

* GET /tasks endpoint now allows to retrieve multiple tasks in a single request by passing a comma-separated list of task IDs via the id query parameter. Request example: GET /tasks?id=1,2,3

~~[[Image~~:~~API_tokens_2.png|550|center]]~~

'''Important!''' After you close the window you will not be able to check Token again. For security, the Token is not saved to the system. If you lose your token or delete an existing one, you will have to create a new one.

===2025-06-10===

~~=='''FOTA Web API changelog'''==~~

Query parameter "company_id" is removed from GET /batches/{batchId}. This means that batch.task_stats will no longer be filtered by provided "company_id" and will always be calculated from all batch tasks which can be viewed by the user.

===2024-06-28===

~~Here is information on the latest changes~~ to ~~the FOTA Web API~~

Endpoint to select several IMEI's was added. Request example: GET /devices?imei=123,123,123,123,123,....&per_page=100&page=23

===2024-03-01===