API¶

API в Platrum используется для индивидуальной настройки системы. Вы сможете настроить Platrum так, как удобно вам. Например, можно создавать транзакции, приглашать пользователей или ставить задачи.

Если вам необходимо настроить какую-либо автоматизацию или интеграцию с другими вашими системами, в этом также может помочь API Platrum.

Как получить API-ключ¶

Для работы с вашим проектом по API вам потребуется API-ключ. Его вы сможете найти в разделе «Настройки» –> «Проект» в поле API-ключ.

API-ключ доступен только владельцу проекта. У приглашенного сотрудника не будет доступа к ключу. В этом случае он может выполнять запросы к API с помощью своего session_id. Его можно посмотреть в Network браузера.

В этом случае сотруднику, работающему с проектом по API будут доступны только те данные, которые доступны ему в проекте. Если сотрудник в качестве API-ключа использует свой session_id и делает запрос к тем данным, к которым у него нет доступа по настройкам, то он не сможет их получить, в ответе на запрос придет «permission_denied» (доступ запрещен).

Важно: Если вы, как владелец, передадите свой api-ключ из настроек проекта другому человеку, то данные никак не ограничить, т.к. для системы такой запрос выполняет владелец проекта.

Поэтому не передавайте API-ключ третьим лицам. При наличии API-ключа можно выполнить любое действие в вашем проекте от лица владельца, что может нанести вам ущерб.

Если в документации неполная информация¶

Документация по работе с API находится в процессе заполнения, в ней может отсутствовать описание некоторых методов.

Если в процессе работы вы не нашли в документации описания нужного вам метода, вы можете посмотреть его формат в консоли вашего браузера.

Если этого недостаточно, напишите нам через виджет чата или на почту support@platrum.ru, наши сотрудники передадут вопрос разработчикам продукта, и мы поможем разобраться.