REST API: Difference between revisions
From Planfix
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 21: | Line 21: | ||
*Port Planfix service to other platforms, including mobile platforms; | *Port Planfix service to other platforms, including mobile platforms; | ||
*Create services for obtaining and further using analytical information in Planfix. | *Create services for obtaining and further using analytical information in Planfix. | ||
== Table of Contents == | == Table of Contents == | ||
*[[REST API Introduction]] | *[[REST API Introduction]] | ||
| Line 37: | Line 36: | ||
*[[REST API: Working with files]] | *[[REST API: Working with files]] | ||
*[[Testing requests on REST API in Postman]] | *[[Testing requests on REST API in Postman]] | ||
== Specification == | == Specification == | ||
*The REST API specification is available at the link: https://help.planfix.com/restapidocs/ | *The REST API specification is available at the link: https://help.planfix.com/restapidocs/ | ||
| Line 43: | Line 41: | ||
https://s.pfx.so/pf/EP/WMxqYu.jpg | https://s.pfx.so/pf/EP/WMxqYu.jpg | ||
== Silent mode == | == Silent mode == | ||
In any data update request, you can add the parameter '''silent=true''' (query parameter). In this case, the change will not be shown in the logs, and no notifications will be sent. It may be necessary if you transfer data from another system to Planfix through this API or regularly synchronize data from another system with Planfix. | In any data update request, you can add the parameter '''silent=true''' (query parameter). In this case, the change will not be shown in the logs, and no notifications will be sent. It may be necessary if you transfer data from another system to Planfix through this API or regularly synchronize data from another system with Planfix. | ||
== Additionally == | == Additionally == | ||
*Data coming into Planfix can be further [[Calculate Infoblock|processed]] before use. | *Data coming into Planfix can be further [[Calculate Infoblock|processed]] before use. | ||
*Suppose you change tasks via the REST API using the POST /task/{id} method. In that case, the following logic applies: If the task is currently being changed in parallel (by an automation script or another request) and cannot be changed immediately, the requested change is placed in a queue in Planfix and executed as soon as the task is available. In this case, the response status is 202. If the change is made immediately, the response is 200. | |||
Latest revision as of 13:07, 23 October 2024
Working with the API is available only in paid or premium accounts. The functionality of REST API is not complete. We are gradually expanding it.
Planfix REST API is a set of interfaces designed to provide access to Planfix account data via the HTTP protocol and JSON data format.
The API allows you to quickly and easily create web and desktop applications that can be integrated with any Planfix account.
Here are some examples of what you can use the Planfix API interfaces for:
- Create your applications or services based on Planfix;
- Develop add-ons to main features to expand the ways you can use Planfix;
- Import data from other systems into Planfix;
- Export data from Planfix to other systems;
- Organize notifications about tasks and actions in Planfix in a way that is convenient for the customer;
- Port Planfix service to other platforms, including mobile platforms;
- Create services for obtaining and further using analytical information in Planfix.
Table of Contents
- REST API Introduction
- API terms of use
- REST API Authorization
- REST API List of access levels – scope
- REST API: Error codes
- REST API: Complex task filters
- REST API: Complex project filters
- REST API: Complex employee filters
- REST API: Complex contact filters
- REST API: Complex data tag filters
- REST API: Complex directory filters
- Reports on API
- REST API: Working with files
- Testing requests on REST API in Postman
Specification
- The REST API specification is available at the link: https://help.planfix.com/restapidocs/
- If you use the link to the REST API from your account, then requests will be executed directly in your account, not on test data:
Silent mode
In any data update request, you can add the parameter silent=true (query parameter). In this case, the change will not be shown in the logs, and no notifications will be sent. It may be necessary if you transfer data from another system to Planfix through this API or regularly synchronize data from another system with Planfix.
Additionally
- Data coming into Planfix can be further processed before use.
- Suppose you change tasks via the REST API using the POST /task/{id} method. In that case, the following logic applies: If the task is currently being changed in parallel (by an automation script or another request) and cannot be changed immediately, the requested change is placed in a queue in Planfix and executed as soon as the task is available. In this case, the response status is 202. If the change is made immediately, the response is 200.