Adición de identificador único de integración

Para configurar una integración con Dotcom-Monitor, debe tener acceso a una cuenta activa de Dotcom-Monitor y crear un identificador único de API web para usarlo en la solicitud de autenticación:

  1. Inicie sesión en la cuenta dotcom-monitor.
  2. En Dotcom-Monitor, cree un UID de integración en Configurar > integraciones > Agregar API web de integración > .
  3. Opcional:Si la cuenta maestra contiene departamentos y desea acceder y enviar solicitudes a la API de un departamento específico, en la ventana Agregar integración, seleccione Permitir acceso a los datos del departamento.
  4. Haga clic en Crear integración y copie el identificador único de la API web de la lista UED de integración en el portapapeles(API web (con acceso a los datos del departamento) en el caso del acceso al departamento).

Autenticación

URL de solicitud

Exponer https://api.dotcom-monitor.com/config_api_v1/login

Cuando inicia sesión en su cuenta a través de la llamada “/login”, comienza una nueva sesión de cliente. Las sesiones caducan automáticamente después de una duración predeterminada de la inactividad. El valor predeterminado es 1 minuto. Si realiza una llamada a la API, el temporizador de inactividad se restablece a cero.
Cuando expira la sesión, se devuelve el código de error HTTP de excepción “401 – Unauthorized”. Si esto sucede, debe volver a iniciar sesión de nuevo.

Después de la autorización, el cliente está siendo identificado por cookie, así que asegúrese de que las cookies están habilitadas.

Post Contenido

Acceso UID (preferible)

Utilice el identificador único de la API web como valor del parámetro UID (Configure > Integrations > Add Integration Web > API).

{
"UID":"1423e214d153d123123"
}

Acceso al ID del departamento

Para acceder a los datos de un departamento a través de la API, use el identificador único de la API web (con acceso a los datos del departamento) como parámetro “UID” y envíe una solicitud de autenticación utilizando el siguiente ejemplo de contenido Post:

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

En este caso, el sistema responderá con la lista de los departamentos de los departamentos disponibles.

{
    "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
                }
            ]
        }
    ]
}

Copie el identificador del departamento en el que desea iniciar sesión y utilízalo junto con el UID de la API web para crear una solicitud de autenticación al departamento. Utilice el ejemplo siguiente:

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

Nombre de usuario y contraseña heredados (no recomendados, pueden requerir ID de cuenta)

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

Respuesta de éxito

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