Добавление уникального идентификатора интеграции

Для настройки интеграции с Dotcom-Monitor необходимо иметь доступ к активной учетной записи Dotcom-Monitor и создать уникальный идентификатор Web API для использования в запросе на аутентификацию:

  1. Войдите в учетную запись Dotcom-Monitor.
  2. В Dotcom-Monitor создайте UID интеграции в разделе Настройка > интеграций Добавление > > веб-APIинтеграции .
  3. Необязательно:если главная учетная запись содержит отделы и вы хотите получить доступ к API определенного отдела и отправлять запросы в него, в окне Добавить интеграцию выберите Разрешить доступ к данным отдела.
  4. Щелкните Создать интеграцию и скопируйте уникальный идентификатор веб-API из списка ИДЕНТИФИКАТОРОВ интеграции в буфер обмена(веб-API (с доступом к данным отдела) в случае доступа к отделу).

аутентификация

URL-адрес запроса

Поместить https://api.dotcom-monitor.com/config_api_v1/login

Когда вы входите в свою учетную запись через вызов «/login», начинается новая клиентская сессия. Срок действия сеансов автоматически истекает после предопределенной продолжительности бездействия. Значение по умолчанию составляет 1 минуту. При вызове API таймер бездействия сбрасывается до нуля.
По истечении срока действия сеанса возвращается код ошибки HTTP “401 – Несанкционированный”. Если это произойдет, вы должны повторно войти снова.

После авторизации клиент идентифицируется по файлам cookie, поэтому убедитесь, что файлы cookie включены.

Post Содержание

Доступ к UID (предпочтительнее)

Используйте уникальный идентификатор веб-API в качестве значения параметра UID (Настройка > интеграций > Добавить > веб-APIинтеграции ).

{
"UID":"1423e214d153d123123"
}

Доступ к идентификатору отдела

Чтобы получить доступ к данным Отдела через API, используйте уникальный идентификатор веб-API (с доступом к данным отдела) в качестве параметра “UID” и отправьте запрос на проверку подлинности с помощью следующего образца содержимого Post:

{ 
"UID" : "4821737B71224A087641585F80BF8",
"Action": 1
}

В этом случае система ответит списком доступных идентификаторов отделов.

{
    "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 веб-API для создания запроса проверки подлинности в Отдел. Используйте следующий пример:

{ 
"UID" : "4821737B71B22A087641585F80BF8"
 "Id" : "19357"
}

Устаревшее имя пользователя и пароль (не рекомендуется, может потребоваться идентификатор учетной записи)

{
"username":"username",
"password":"password"
}

Реакция на успех

{
"Success":true,
"Result":"OK"
}