Для: Администраторы
Аутентификация API-запросов с помощью ключа.
Отправьте свой ключ в виде токена носителя в API панели администратора для управления ключом или в API портала для ключа хаба, ограничив его использование только вашими IP-адресами.
В этой статье5 разделов
Прежде чем начать
На этой странице указано, куда следует отправлять каждый вид материалов. Ключ APIКлюч Секретный токен, созданный в рамках интеграции, позволяет вашему собственному программному обеспечению использовать API хаба., Как можно отправить его, и почему ключ отклоняется при отправке.
Адреса
| Ключ | Базовый адрес | Пример |
|---|---|---|
| Управляйте ключевыми элементами | https://prd-api-manage.caseactive.com/v1/<hub id>/ | https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Управление ключевыми данными, импортом | https://prd-api-manage.caseactive.com/v1/integration/<hub id>/ | https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports |
| Ключ для включения устройства | https://prd-api-app.caseactive.com/v1/<hub id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Ключ Hub Key – один экземпляр. | https://prd-api-app.caseactive.com/v1/<hub id>/<case id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts |
Ваш ID хаба – ca- И еще 14 символов. Это выглядит так: Идентификатор концентратора на самом деле Обзор На любой странице вашего портала есть кнопка для загрузки копии информации о данном случае. У каждого случая имеется свой идентификатор. cc- И еще 14 символов. Они выглядят так: Идентификатор дела.
Отправка ключа
Послать ключ в заголовке Authorization при каждом вызове. После Bearer следует стоять пробел.
curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
-H "Authorization: Bearer YOUR_API_KEY"
- Отправляйте JSON-объекты с помощью элемента
Content-Type: application/json. - Ключ не истекает сроком его действия. Он будет работать до тех пор, пока администратор не отключит его или не удалит его в разделе Интеграция › Ключи.
- Все позывные обозначаются заново: не существует никаких сессий или токенов для обмена информацией.
- Даты и время указываются в UTC.
Ограничение мест его использования
Под Источник CIDR можно указать публичный IPv4 адрес вашего системы, например 203.0.113.10, или диапазон адресов, например 203.0.113.0/24. API поддерживает только соединения по IPv4-протоколу; поэтому указание IPv6-адреса или диапазона адресов при сохранении будет отклонено. Запросы из любых других мест также будут отклонены с кодом ошибки 401 LoginSourceIpException. Чтобы изменить диапазон адресов, смотрите раздел Ограничение или отмена прав на использование API-ключа.
Когда ключ отклонен
Каждое отклонение приводит к возникновению ошибки. В таких случаях имя message указывается в сообщении об ошибке. См. раздел Управление ошибками API и статусными кодами.
| Статус | message | Почему | Что делать |
|---|---|---|---|
| 401 | Unauthorized | Никакой ключа не было отправлено, или же отправленный объект не является ключом. | Проверьте заголовок Authorization. |
| 401 | HostNotFoundException | Идентификатор хаба в адресе не существует. | Скопируйте снова Идентификатор концентратора. |
| 401 | HostPurgingException | Хаб удаляется. | Попросите администратора вашего хаба о помощи. |
| 401 | SessionNotFoundException | Ключ был удален или принадлежит другому узлу. | Используйте актуальный ключ для этой хаба. |
| 401 | LoginKeyInactiveException | Ключ выключен. | Попросите администратора включить этот функционал. |
| 401 | LoginKeyWrongApiException | Ключ управления был отправлен по адресу ключа хаба, или наоборот. | Используйте указанный адрес для определения тип ключа. |
| 401 | LoginSourceIpException | Звонок пришел из-за пределов досягаемости ключа. | Звоните с разрешенного адреса, или расширьте диапазон доступных номеров. |
| 401 | LoginSourceCidrException | Нельзя прочитать информацию о диапазоне мест, где хранится ключ. | Правильно: Источник CIDR |
| 403 | BotNotAllowedException | Управляющий ключ называется нечем, что он вообще может использовать. | См. Что может делать этот API? |
| 403 | ManageBillingInactiveException | Административная панель вашего хаба заблокирована после неудачной попытки оплаты. Можно только управлять ключом для доступа к административной панели. | Попросите администратора обновить способ оплаты. |
| 403 | BillingReadOnlyException | Подписка вашего хаба закончилась, а его портал теперь является только для чтения. Поэтому ключ хаба может лишь читать информацию, но не может ничего изменять. | Попросите администратора перезапустить подписку. |
| 403 | CaseClosedException | Ключ-хаб пытался открыть закрытый ящик. | Сначала необходимо снова открыть этот дел. |
| 404 | CaseNotFoundException | Ключ к хабу указывает на случай, который на самом деле не существует, или находится не в вашем хабе. | Проверьте номер дела. |
| 503 | LoginSessionException | Хаб был слишком занят, чтобы можно было проверить ключ. | Попробуйте снова вскоре. |
Ошибка 401 всегда означает, что сам ключ был отклонен. Это может привести к прекращению процесса синхронизации и вызвать оповещение у пользователя. Другие ошибки связаны с самой телефонной связью.