API-Schlüssel generieren und auf die Perform & Engage 365 API zugreifen

Erforderliche Rolle: Super-Admin.

API-Schlüssel generieren

Bevor Sie auf die Perform & Engage 365 API zugreifen können, müssen Sie die API-Schlüssel generieren. So generieren Sie API-Schlüssel:

1. Wählen Sie das Zahnradsymbol für Einstellungen > API-Schlüssel aus. Die Seite API-Schlüsselverwaltung öffnet sich.

Diese Seite zeigt aktive API-Schlüssel an. Jeder API-Schlüssel umfasst drei Spalten:

• Benutzername. Der Benutzername des API-Benutzers. Jeder Benutzername ist eindeutig.
• API-Schlüssel. Dies ist ein Passwort. Wählen Sie Click to reveal aus, um den API-Schlüssel anzuzeigen.
• Löschen. Aktivieren Sie das Kontrollkästchen und wählen Sie dann Delete Selected aus, um den API-Schlüssel zu löschen.  

2. Wählen Sie Generate New aus, um einen neuen API-Schlüssel zu generieren.

Jede Anfrage an die Perform & Engage 365 API erfordert den Header Authorization, der HTTP Basic Authentication verwendet. Verwenden Sie Username und API key über das Zahnradsymbol > API keys, um die Anmeldedaten Base64-codiert zu übertragen und den Header zu generieren.

Anfragen über Swagger senden

Sie können auch Swagger verwenden, um auf die Perform & Engage 365 API zuzugreifen und Anfragen zu senden. So greifen Sie auf Swagger zu:

1. Öffnen Sie {{region}}.weekly10.net/api/v2/swagger-ui, wobei {{region}} der regionale Teil Ihrer Perform & Engage 365-URL ist. Wenn Ihre Perform & Engage 365-URL also pro.weekly10.net lautet, ist die URL für Swagger pro.weekly10.net/api/v2/swagger-ui.

2. Der Pop-up-Bildschirm Sign in mit den Feldern Username und Password wird angezeigt. Geben Sie die Zugangsdaten ein, die Sie über das Zahnradsymbol „Einstellungen“ > API-Schlüssel erstellt haben, und wählen Sie Sign in aus.

So senden Sie die Anfragen über Swagger:

1. Wählen Sie die API-Anfrage aus.

2. Wählen Sie oben rechts Try it out aus.

3. Geben Sie bei Bedarf die Abfrageparameter ein.

4. Wählen Sie Execute aus.

5. Gehen Sie zum Block Response, um die Ergebnisse zu überprüfen.