Difference between revisions of "FOTA WEB Getting Started API"

From Wiki Knowledge Base | Teltonika GPS
 
(16 intermediate revisions by 6 users not shown)
Line 3: Line 3:
 
=='''API introduction'''==
 
=='''API introduction'''==
  
−
FOTA WEB API allows use of system functions in your own application. If you have user in FOTA WEB then you already have API access!
+
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!
 
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!
 
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'''==
 
=='''Getting Started API'''==
  
−
How to start using FOTA WEB API. You will find all of the API documentation at https://api.teltonika.lt/documents/
+
=== How to start using FOTA WEB API. You will find all of the API documentation at ===
 +
'''https://api.teltonika.lt/documents/'''
 +
 
 +
=== To be able to use API you will need to have token===
 +
Token will be key for your access. It can be created over FOTA WEB UI '''https://fota.teltonika.lt'''
  
−
To be able to use API you will need to have token. Token will be key for your access. It can be created over FOTA WEB UI https://fm.teltonika.lt
 
 
=='''Creating API token'''==
 
=='''Creating API token'''==
−
'''Step 1.''' To create token Login to https://fm.teltonika.lt
+
'''Step 1.''' To create token Login to '''https://fota.teltonika.lt'''
  
−
'''Step 2.''' Go to settings at top right corner and find API Tokens settings.
+
'''Step 2.''' Go to settings at top right corner and find '''API Tokens''' settings.
 
[[Image:Settings_API.png|300px|center]]
 
[[Image:Settings_API.png|300px|center]]
−
'''Step 3.''' Write name for the Token (1) and press Create (2).
+
 
−
[[Image:API_tokens.png|550px|center]]
+
'''Step 3.''' Write name for the '''New token''' and press '''Create.'''
 +
[[Image:API_tokens_3.png|550px|center]]
 +
 
 
'''Step 4.''' Press on the Token to copy or select it and copy manually.
 
'''Step 4.''' Press on the Token to copy or select it and copy manually.
 
[[Image:API_tokens_2.png|550|center]]
 
[[Image:API_tokens_2.png|550|center]]
  
−
'''Important!''' After you close the window you will not be able to check Token again. For security Token is not saved to the system. If you lose your token or delete existing one, you will have to create new one.
+
'''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
 +
 
 +
===2024-06-28===
 +
 
 +
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===
 +
 
 +
Message field is being moved from task attributes to separate field. Message from attributes will be removed on 2024-03-01.
 +
 
 +
===2023-10-19===
 +
 
 +
Datetime format inside device export files was unified to yyyy-MM-dd HH:mm:ss.
 +
 
 +
===2023-09-07===
 +
 
 +
Separate endpoint for bulk tasks cancellation was added. Endpoint: /tasks/bulkCancel.
 +
 
 +
===2023-08-16===
 +
 
 +
Separate endpoint for retry failed tasks in a task group was added. Endpoint: /batches/{batchId}/retryFailedTasks.
 +
 
 +
===2023-06-30===
 +
 
 +
Removed company statistics from GET /companies/<ID> response:
 +
 
 +
* `device_count`
 +
* `user_count`
 +
* `file_count`
 +
* `group_count`
 +
* `task_count`
 +
* `company_count`
 +
 
 +
This data can still be accessed via dedicated endpoint GET /companies/stats?company_id=<ID>
 +
 
 +
===2023-04-05===
 +
 
 +
Removed device properties:
 +
* `status_id`
 +
* `status_name`
 +
 
 +
These properties are replaced by `activity_status` and `task_queue` that were introduced on 2022-12-20.
 +
 
 +
===2022-12-20===
 +
 
 +
Added new device properties:
 +
* `activity_status`
 +
* `task_queue`
 +
 
 +
 
 +
 
 +
{|style="width:100%;"
 +
|-
 +
|[https://wiki.teltonika-gps.com/view/Account_Settings'''Account Settings'''] - Previous page
 +
|style="text-align:right;| Next page - [https://wiki.teltonika-gps.com/view/Company_levels '''FOTA Company levels''']
 +
|}
 +
 
 +
[[Category:FOTA WEB]]

Latest revision as of 07:33, 1 July 2024

Main Page > Software & Applications > FOTA WEB > FOTA WEB Getting Started API

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! 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

How to start using FOTA WEB API. You will find all of the API documentation at

https://api.teltonika.lt/documents/

To be able to use API you will need to have token

Token will be key for your access. It can be created over FOTA WEB UI https://fota.teltonika.lt

Creating API token

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

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

Settings API.png

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

API tokens 3.png

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

550

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

2024-06-28

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

Message field is being moved from task attributes to separate field. Message from attributes will be removed on 2024-03-01.

2023-10-19

Datetime format inside device export files was unified to yyyy-MM-dd HH:mm:ss.

2023-09-07

Separate endpoint for bulk tasks cancellation was added. Endpoint: /tasks/bulkCancel.

2023-08-16

Separate endpoint for retry failed tasks in a task group was added. Endpoint: /batches/{batchId}/retryFailedTasks.

2023-06-30

Removed company statistics from GET /companies/<ID> response:

  • `device_count`
  • `user_count`
  • `file_count`
  • `group_count`
  • `task_count`
  • `company_count`

This data can still be accessed via dedicated endpoint GET /companies/stats?company_id=<ID>

2023-04-05

Removed device properties:

  • `status_id`
  • `status_name`

These properties are replaced by `activity_status` and `task_queue` that were introduced on 2022-12-20.

2022-12-20

Added new device properties:

  • `activity_status`
  • `task_queue`


Account Settings - Previous page Next page - FOTA Company levels
Retrieved from "https://wiki.teltonika-gps.com/index.php?title=FOTA_WEB_Getting_Started_API&oldid=99168"