Термины и определения

1. Контакт - договор о структуре тела запроса состоящая из набора полей, где у каждого поля определены свойства(тип данных, ограничения, спецификация);

2. Квоты - допустимое кол-во запросов за единицу времени;

3. Схема - подробное описание всех методов, доступно по адресу https://{workSpace}.pipeline24.net/rest/api/schema

4. Родительский контракт - базовый контракт, обязательный для всех запросов. Тело остальных контрактов должно содержаться в поле data родительского контракта.

5. Подпись (signature) - контрольное значение на базе которого происходит Аутентификация сторонних систем при обмене данными.

Signature

Поле signature родительского контракта - формируется по спецификации hmac 256. Структура подписи следующая: {data}{time}{path} где:

• data - преобразованная в json поле data родительского контракта (без указания параметров);

• time - unix timestamp;

• path - url запроса, например ‘/rest/api/schema’;

Permissions

Доступность методов api настраивается в Настройки→Источники→API.
Перечень доступных методов определяется для каждой интеграции индивидуально.

Логирование

Результаты выполнения запросов можно исследовать тут - Лог→Api

Open Api

Актуальная версия api находится по адресу
https://stand.pipeline24.net/rest/api/schema

Адрес вашего api вы можете найти в разделе Настройки→Источники→API.