API-ключ
Ссылка на документацию: https://docs.prmbusiness.ru
Раздел предназначен для получения и управления ключом доступа к API платформы. С его помощью можно автоматизировать получение информации о партнерах, лидах, выплатах, транзакциях, статистике, материалах и других сущностях, доступных в системе.
API позволяет внешним системам автоматически взаимодействовать с данными партнерской программы без необходимости выполнять операции вручную.
Получение API-ключа
Для начала работы с API необходимо создать персональный ключ доступа путем нажатия на кнопку «Создать API-ключ». После создания система автоматически сгенерирует уникальный ключ, который будет использоваться для авторизации всех запросов к API. Рядом с ключом расположена кнопка копирования, позволяющая быстро скопировать значение в буфер обмена для последующего использования
Полученный ключ рекомендуется хранить в безопасности и не передавать третьим лицам, так как любой пользователь, имеющий доступ к ключу, сможет выполнять запросы от имени вашей учетной записи в рамках предоставленных прав доступа.
Обновление API-ключа
При необходимости ключ можно заменить с помощью кнопки «Обновить API-ключ». После обновления система генерирует новый API-ключ, а предыдущий автоматически становится недействительным.
Важно учитывать, что после обновления все существующие интеграции, использующие старый ключ, перестанут работать до тех пор, пока в их настройках не будет указан новый ключ доступа.
Документация API
Для упрощения интеграции в разделе доступна кнопка «Документация API»
После перехода открывается интерактивная документация, содержащая:
- список доступных методов API
- описание всех эндпоинтов
- параметры запросов
- структуры ответов
- требования к авторизации
- примеры запросов и ответов
- информацию об ошибках и кодах ответов
Безопасность
При работе с API мы рекомендуем соблюдать следующие меры безопасности:
- не публиковать API-ключ в открытом доступе
- не передавать ключ посторонним лицам
- хранить ключ в защищенных конфигурационных файлах
- периодически обновлять ключ доступа
- незамедлительно перевыпускать ключ при подозрении на его компрометацию