Добавление уникального идентификатора интеграции
Для настройки интеграции с Dotcom-Monitor необходимо иметь доступ к активной учетной записи Dotcom-Monitor и создать уникальный идентификатор Web API для использования в запросе на аутентификацию:
- Войдите в учетную запись Dotcom-Monitor.
- В Dotcom-Monitor создайте UID интеграции в разделе Настройка > интеграций Добавление > > веб-APIинтеграции .
- Внесите IP-адреса в белый список, как описано в статье Как внести IP-адреса в белый список для доступа к веб-API нашей вики.
- Необязательно:если главная учетная запись содержит отделы и вы хотите получить доступ к API определенного отдела и отправлять запросы в него, в окне Добавить интеграцию выберите Разрешить доступ к данным отдела.
- Щелкните Создать интеграцию и скопируйте уникальный идентификатор веб-API из списка ИДЕНТИФИКАТОРОВ интеграции в буфер обмена(веб-API (с доступом к данным отдела) в случае доступа к отделу).
аутентификация
URL-адрес запроса
| Поместить | https://api.dotcom-monitor.com/config_api_v1/login |
Когда вы входите в свою учетную запись через вызов «/login», начинается новая клиентская сессия. Срок действия сеансов автоматически истекает после предопределенной продолжительности бездействия. Значение по умолчанию составляет 1 минуту. При вызове API таймер бездействия сбрасывается до нуля.
По истечении срока действия сеанса возвращается код ошибки HTTP «401 — Несанкционированный». Если это произойдет, вы должны повторно войти снова.
Post Содержание
Используйте уникальный идентификатор веб-API в качестве значения параметра UID (Настройка > интеграций > Добавить > веб-APIинтеграции ).
{
"UID":"1423e214d153d123123"
}
Доступ к идентификатору отдела
Чтобы получить доступ к данным отдела через API, необходимо создать интеграцию Web API (с доступом к данным отдела). Используйте соответствующий уникальный идентификатор в качестве параметра UID в сочетании с парой «Действие»: 1 имя/значение в запросе аутентификации.
Используйте следующий пример содержимого публикации:
{
"UID" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Action": 1
}
Система ответит списком доступных идентификаторов отделов. Смотрите пример JSON ниже.
{
"Success": true,
"Result": [
{
"Name": "my_org",
"HasCompany": true,
"HasDepartment": true,
"Qantity": 2,
"Accounts": [
{
"Id": 15530,
"Name": "my_org",
"CompanyName": "my company",
"Email": "email@gmail.com",
"Owner": true,
"Department": false,
"New": false
},
{
"Id": 19357,
"Name": "Admin",
"CompanyName": "my company",
"Email": "email111@gmail.com",
"Owner": true,
"Department": true,
"New": false
}
]
}
]
}
Скопируйте идентификатор отдела, в который вы хотите войти, и используйте его вместе с UID для создания запроса на аутентификацию в отдел.
Используйте приведенный ниже пример публикации.
{
"UID" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
"Id" : "XXXX"
}
Где » UID»:»XXXXX…. XXX » — это UID вашего веб-API (с доступом к данным отдела) и » Id»: «XXXX» — идентификатор вашего отдела.
Реакция на успех
{
"Success":true,
"Result":"OK"
}