API¶

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

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

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

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

В Platrum есть два варианта доступа к API:

• API-ключ проекта (в настройках проекта) — ключ владельца с полным уровнем доступа владельца.

• Персональные API-ключи сотрудников — доступны сотрудникам с правом «Управление своими API ключами» в разделе «Настройки» → «API ключи».

Сотрудник видит и удаляет только свои ключи. При создании ключа с доступами можно выбрать только те доступы, которые уже есть у самого сотрудника. Session_id также можно использовать для запросов от имени текущего пользователя. В этом случае действуют его обычные права доступа, и при нехватке прав API вернёт permission_denied.

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

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

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

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

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

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

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