Adicionando identificador exclusivo de integração

Para configurar uma integração com o Dotcom-Monitor, você deve ter acesso a uma conta ativa do Dotcom-Monitor e criar um Identificador Único de API da Web para usar na solicitação de autenticação:

  1. Faça login na conta do Dotcom-Monitor.
  2. No Dotcom-Monitor, crie um UID de integração sob configuração > de integrações > Adicione API web de integração > .
  3. Opcional: Se a conta-mestre contiver Departamentos e você quiser acessar e enviar solicitações à API de um Departamento específico, na janela Adicionar Integração, selecione Permitir acesso aos dados do departamento.
  4. Clique em Criar Integração e copie o Identificador Exclusivo de API da lista de UIDs de Integração para a área de transferência(API da Web (com acesso aos dados do departamento) no caso de acesso ao Departamento).

Autenticação

Solicitar URL

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

Quando você faz login na sua conta através da chamada “/login”, uma nova sessão de clientes começa. As sessões expiram automaticamente após um período predeterminado de inatividade. O padrão é de 1 minuto. Se você fizer uma chamada de API, o temporizador de inatividade será reiniciado a zero.
Quando sua sessão expira, o código de erro HTTP de exceção “401 – Não autorizado” é devolvido. Se isso acontecer, você deve fazer login novamente.

Após a autorização, o cliente está sendo identificado por cookie, por isso certifique-se de que os cookies estão ativados.

CONTEÚDO POST

Acesso UID (preferível)

Use o Identificador Exclusivo da API da Web como o valor do parâmetro UID (Configure > Integrações > Adicionar API Web de Integração > ).

{
"UID":"1423e214d153d123123"
}

Acesso à ID do Departamento

Para acessar os dados de um Departamento através da API, use a API da Web (com acesso aos dados do departamento) Identificador Único como parâmetro “UID” e envie uma solicitação de autenticação usando a seguinte amostra de conteúdo do Post:

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

Neste caso, o sistema responderá com a lista de IDs dos Departamentos disponíveis.

{
    "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 a ID do Departamento que deseja fazer login e use-a em conjunto com o UID da Web API para criar uma solicitação de autenticação ao Departamento. Use a seguinte amostra:

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

Nome de usuário e senha legados (não recomendados, podem exigir identificação da conta)

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

Resposta de sucesso

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