Introduction

Application registration

For the application to be able to start working, you need to generate an authentication key and signature key. Account managers can do this in the section Account management / Access to API.

Important

The API can only be used with paid and premium accounts.

Access to interfaces

Access to the interface is established through a single entry point located at:

https://api.planfix.ru/xml/ - for accounts located in Europe

https://apiru.planfix.ru/xml/ - for accounts located in Russia

Please note that the interface is accessed over HTTPS. All API calls using an unsecured connection will be automatically ignored, so we recommend establishing a test secure connection with an access point to Planfix interfaces before sending data.

All API calls are executed through POST requests.

Limitations on requests

By default, all accounts are limited based on their plan (20/50/100,000 requests per day) and are limited to one request per second. Additionally, all methods that return lists of values are limited to 100 results per request. The approximate number of remaining requests per day is returned in the X-RateLimit-Remaining header (this value is updated approximately every 10 minutes).

Request format

The request packet has the following structure

</source>

Название	Тип	Значение	Примечание
account	string	аккаунт на котором будет выполняться функция	обязательное поле и присутствует во всех запросах
sid	string(32)	ключ сессии полученный в результате выполнения функции auth	если используется аутентификация по логину/паролю