Hinzufügen eines eindeutigen Integrationsbezeichners

Um eine Integration mit Dotcom-Monitor einzurichten, müssen Sie Zugriff auf ein aktives Dotcom-Monitor-Konto haben und einen eindeutigen Web-API-Bezeichner erstellen, der in der Authentifizierungsanforderung verwendet werden kann:

  1. Melden Sie sich beim Dotcom-Monitor-Konto an.
  2. Erstellen Sie in Dotcom-Monitor eine Integrations-UID unter > Configure Integrations > Add Integration Web > API.
  3. Optional: Wenn das Hauptkonto Abteilungen enthält und Sie auf die API einer bestimmten Abteilung zugreifen und diese an diese senden möchten, wählen Sie im Fenster Integration hinzufügen die Option Zugriff auf Abteilungsdaten zulassenaus.
  4. Klicken Sie auf Integration erstellen und kopieren Sie den eindeutigen Web-API-Bezeichner aus der Liste Integrations-UIDs in die Zwischenablage(Web-API (mit Zugriff auf die Daten der Abteilung) im Falle des Abteilungszugriffs).

Authentifizierung

URL anfordern

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

Wenn Sie sich über den Aufruf “/login” in Ihr Konto einloggen, beginnt eine neue Kundensitzung. Sitzungen laufen automatisch nach einer vorgegebenen Dauer der Inaktivität ab. Der Standardwert ist 1 Minute. Wenn Sie einen API-Aufruf durchführen, wird der Inaktivitätszeitgeber auf Null zurückgesetzt.
Wenn Ihre Sitzung abläuft, wird der Ausnahme-HTTP-Fehlercode “401 – Unauthorized” zurückgegeben. In diesem Fall müssen Sie sich erneut anmelden.

Nach der Autorisierung wird der Client durch Cookies identifiziert, also stellen Sie sicher, dass Cookies aktiviert sind.

POST-Inhalt

UID-Zugriff (vorzugsweise)

Verwenden Sie Den eindeutigen Bezeichner der Web-API als UID-Parameterwert (Konfigurieren von > Integrationen, Integrations-Web-API > > ).

{
"UID":"1423e214d153d123123"
}

Zugriff auf Abteilungs-ID

Um über die API auf die Daten einer Abteilung zuzugreifen, verwenden Sie die Web-API (mit Zugriff auf die Daten der Abteilung) Unique Identifier als Parameter “UID” und senden Sie eine Authentifizierungsanforderung mit dem folgenden Post-Inhaltsbeispiel:

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

In diesem Fall reagiert das System mit der Liste der verfügbaren Abteilungs-IDs.

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

Kopieren Sie die ID der Abteilung, in der Sie sich anmelden möchten, und verwenden Sie sie in Verbindung mit der Web-API-UID, um eine Authentifizierungsanforderung an die Abteilung zu erstellen. Verwenden Sie das folgende Beispiel:

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

Legacy-Benutzername und -Kennwort (nicht empfohlen, erfordern möglicherweise Konto-ID)

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

Erfolgsreaktion

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