Übersicht

API-Aufrufe ermöglichen es jedem Drittanbietersystem, mit unserem System zu interagieren. Es gibt mehrere Möglichkeiten, einen API-Aufruf zu machen. Du kannst API-Aufrufe mit Programmiersprachen, Kommandozeilen-Tools, API-Client-Frameworks und anderen machen.

In diesem Artikel verwenden wir API-Client-Frameworks, nämlich Postman. Du kannst Postman hier herunterladen.

Sobald du die Software heruntergeladen hast, wirst du diesen Bildschirm sehen.

Hier wirst du deine API-Aufrufe machen. Um sofort loszulegen, klicke auf „Workspaces“ > „Mein Workspace“ oder erstelle gerne einen neuen Workspace.

Wie fängst du an, API-Aufrufe zu machen?

Bevor du beginnst, benötigst du in einigen Fällen deinen Token. Du kannst ihn bekommen, indem du zu „Einstellungen“ > „LinkedIn-Kontoeinstellungen“ gehst, nach unten scrollst und dort den „Account API-Token“ siehst.

Bewege den Mauszeiger über den Sammlungsnamen, bis du die drei Punkte siehst. Klicke darauf und wähle „Anfrage hinzufügen“.
Nachdem du auf „Anfrage hinzufügen“ geklickt hast, siehst du eine Benutzeroberfläche. Beginne damit, die URL einzutragen, an die wir die Anfrage senden werden. In diesem Fall werden wir die Anfrage an https://app.dotsimple.io/api/statistics/GetCampaignStatistics senden, aber dies kann je nach Anfrage variieren.
Nachdem du die URL eingegeben hast, müssen wir die Parameter hinzufügen. Da wir Kampagnenstatistiken abrufen, erfordert diese Anfrage die Parameter accountId, campaignId und token im Tab „Parameter“. Um die Parameter hinzuzufügen, gib einfach den Namen des Parameters in das Feld „Key“ ein.
Bisher sollte es so aussehen:
Nachdem du diese Werte eingegeben hast, klicke auf „Senden“, und du solltest einen 200 OK-Status erhalten, wie unten gezeigt.
Sobald du auf „Senden“ klickst, werden die Informationen angezeigt.

Welche Aktionen kann ich mit API-Aufrufen in DotSimple durchführen?

Aktuell sind folgende Aktionen über API-Aufrufe verfügbar:

Kampagnenstatistiken abrufen
Mitglied importieren
Kontakt aktualisieren
Kontakt abrufen (nach memberId)
Kontakt abrufen (nach öffentlicher Kennung)
Kontakt löschen
Kontakte auflisten (nach öffentlicher Kennung)
Kontakte auflisten (nach campaignId)
Kampagnen auflisten

Kampagnenstatistiken abrufen

Diese Methode ruft die Kampagnenstatistiken für eine gegebene campaignId ab.

Endpoint:
https://app.dotsimple.io/api/statistics/GetCampaignStatistics

Methode:
GET

Parameter:

accountId – ausgewählte accountId
campaignId – ausgewählte campaignId
token – API-Token, das für die ausgewählte accountId erhalten wurde

Beispiel:
https://app.dotsimple.io/api/statistics/GetCampaignStatistics?accountId=56456&campaignId=100706&token=RcchbP2dVNGBxSj3

Das Ergebnis wird sein:

Mitglied importieren

Diese Methode ermöglicht es, einen neuen Kontakt (Kampagnenmitglied) zu einer bestimmten Kampagne hinzuzufügen (das gleiche kann auch mit der CSV-Import-Funktion gemacht werden).

Endpoint:
https://mvc.dotsimple.io/api/members/Import

Methode:
GET

Parameter:

accountId – ausgewählte accountId
campaignId – ausgewählte campaignId
token – API-Token, das für die ausgewählte accountId erhalten wurde
linkedInUrl – LinkedIn-Profil-URL des hinzuzufügenden Kontakts
(optional): firstName, lastName, occupation, location

Das Ergebnis wird sein:

Kontakt aktualisieren

Diese Methode ermöglicht es, einen bestehenden Kontakt (Kampagnenmitglied) zu aktualisieren, d.h. die vorhandenen Details zu ändern.

Endpoint:
https://mvc.dotsimple.io/api/members/(Mitglieds-ID einfügen)

Methode:
POST

Parameter:

memberId – ausgewählte memberId
accountId – ausgewählte accountId
token – API-Token, das für die ausgewählte accountId erhalten wurde

Beispiel:
https://mvc.dotsimple.io/api/members/16659367?accountId=27845&token=mULTzTsfweVofsYYq7

Body-Parameter

Ergebnis

GetContact (nach memberId)

Diese Methode ermöglicht es, einen Kontakt (Kampagnenmitglied) abzurufen und alle Informationen darüber anzuzeigen.

Endpoint:
https://mvc.dotsimple.io/api/members/{memberId}
Methode:
GET

Parameter:

memberId – ausgewählte memberId
accountId – ausgewählte accountId
token – API-Token, das für die ausgewählte accountId erhalten wurde

Beispiel:
https://mvc.dotsimple.io/api/members/161468367?token=mULTzTsdxlVofsYYq7&accountId=27452

Das Ergebnis wird sein:

GetContact (nach öffentlicher Kennung)

Diese Methode ermöglicht es, einen Kontakt (Kampagnenmitglied) abzurufen und alle Informationen darüber anzuzeigen, aber anstelle einer memberId wird die öffentliche Kennung verwendet.

Endpoint:
https://mvc.dotsimple.io/api/members/
Methode:
GET

Parameter: