Для: Администраторы
Разберитесь, что может делать API.
Узнайте, к чему могут иметь доступ ключ управления и ключ концентратора, почему каждый ключ действует как виртуальный помощник и где находится полный технический паспорт.
В этой статье2 разделов
Эта API позволяет вашей собственной программе, например системе управления случаями, работать с вашим хабом, без необходимости использования каких-либо экранов. Для этого используется ключ APIКлюч Секретный токен, созданный в рамках интеграции, позволяет вашему собственному программному обеспечению использовать API хаба.. Существует два вида ключей: ключ для работы с административным панелем, связанный с управлением случаями и людьми, и ключ для работы внутри самого хаба.
Как это работает
Два ключа, два API. Каждый тип ключа соответствует определенному адресу; после этого указывается ID центра управления. Эти адреса отклоняются другими устройствами.
| Ключ | Адрес | До чего оно доходит |
|---|---|---|
| Управляйте ключевыми элементами | https://prd-api-manage.caseactive.com/v1/<hub id>/ | Случаи, люди, их доступ к информации, роли, этапы процесса, способы поиска информации, а также счета для ознакомления с данными. Процесс импорта находится на уровне https://prd-api-manage.caseactive.com/v1/integration/<hub id>/. |
| Ключ для включения устройства | https://prd-api-app.caseactive.com/v1/<hub id>/ | Все, что находится внутри каждого случая: посты и комментарии, файлы, формы, электронные документы, задачи, счета-фактуры, информация о событиях, записи и другие детали данного случая. |
Какое же это замечательное название для управляющего ключа! Только эти. Любые другие запросы в API административной панели приводят к ошибке 403. BotNotAllowedException.
- Случаи: их можно создавать, читать, обновлять и удалять. См. раздел Создание и обновление случаев с использованием функции управления ими.
- Участники случая: список, добавление и удаление. См. раздел Добавление и удаление участников случая с помощью ключа управления.
- Люди: можно добавлять, просматривать информацию о людях, а также отключать или снова включать их в список. См. раздел Добавление и обновление данных о пользователях с помощью управляющего ключа.
- Роли и этапы процесса: читайте информацию в разделе Роли при управлении.
- Пользовательские поля: ознакомьтесь с страницами, связанными с случаями и пользователями. См. раздел Создание и обновление случаев с использованием управляющего ключа.
- Инвойи: необходимо их прочитать. См. раздел Просмотр инвойов с использованием функции управления.
- Поиск. См. раздел Поиск случаев и пользователей с возможностью управления ими.
- Импорт. См. раздел Выполнение импорта с использованием клавиши управления.
Каждая клавиша – это ваш виртуальный помощник. Ключевые признаки того, что ваша точка обращения… Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника.. То, что публикуется, указано под именем и значком Виртуального помощника. Изменения, производимые с помощью Виртуального помощника, также отражаются в его учетных данных. Виртуальный помощник работает в каждом случае, поэтому ключ для доступа к системе распространяется на все случаи. Он может выполнять те функции, которые предусмотрены ролью Виртуального помощника. По умолчанию это то же самое, что и возможности сотрудников. Скрытые случаи доступны только для Виртуального помощника в режиме чтения. Ключ не позволяет создавать новые случаи, добавлять или удалять людей из случаев, оплачивать счета, а также отвечать на запросы пользователей.
Ключи не истекают сроком использования. Эти файлы должны оставаться в активном состоянии до тех пор, пока администратор не отключит их или не удалит. Установите ограничение на количество таких файлов – не более одного на каждый IPv4-адрес публичной сети вашего системы. См.… Ограничить или аннулировать ключ API.
Технические страницы. Каждая API предоставляет полный список своих функций и параметров, используемых при их выполнении. Для использования этих функций не требуется регистрация.
| Управление ключом | Ключ от хаба | |
|---|---|---|
| Интерактивный доступ (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Ссылка/Перечень ресурсов (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| Документ OpenAPI | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
В списке указаны все звонки, которые самыми приложениями совершаются. Среди этих звонков много таких, которые не могут быть осуществлены с помощью клавиш управления. В списке также указано, какие звонки можно осуществить с помощью клавиш управления. Чтобы попробовать совершить звонок на интерактивной странице, выберите соответствующую опцию. Уполномочить Перепишите свой ключ здесь.
Запертый хаб. Когда панель администрирования вашего хаба заблокирована после неудачной оплаты, попытки изменения параметров отклоняются с кодом 403 ManageBillingInactiveException. Хаб продолжает функционировать до тех пор, пока портал не становится недоступным для чтения: через 14 дней после неудачной оплаты, если платеж все еще не был произведен, или в день окончания отмененного подписки. С этого момента хаб все еще может работать, но любые изменения будут отклоняться с кодом 403 BillingReadOnlyException, пока администратор не возобновит подписку.
Когда его использовать
Используйте специальный ключ для того, чтобы ваш центр управления работал в синхронизации с другой системой: создавайте случаи, добавляйте клиентов в эти случаи, отбирайте права доступа у людей после их ухода, или одновременно загружайте несколько записей из файла. Используйте этот ключ для работы с случаями в своем программном обеспечении: например, добавлять новые записи, когда происходят какие-либо изменения в системе.
Чтобы узнавать о изменениях в вашем хабе по мере их произойти, а не ждать их сообщений, используйте вебхук. См. раздел Установка вебхука. Чтобы создать ключ, см. раздел Создание API-ключа.