Verwenden des API-Dashboards

Die Zendesk-API wird durch ein Dashboard in der Administratoroberfläche von Zendesk Support unterstützt. Im API-Dashboard können Sie folgende Aufgaben durchführen:

• Kennwort- oder Tokenzugriff auf die API aktivieren
• API-Token erstellen
• OAuth-Clients erstellen und verwalten
• API-Aktivität verfolgen und mit dem Ratenlimit vergleichen
• Informationen zu HTTP-Zielfehlern abrufen

Nur Zendesk Support-Administratoren haben Zugriff auf das API-Dashboard.

Hinweis: Testkonten sind auf maximal zwei Ziele begrenzt.

Weitere Informationen zur Nutzung der Zendesk API finden Sie auf den folgenden Seiten:

• Einführung in die REST-API auf developer.zendesk.com
• Leitfaden zur Zendesk-API auf help.zendesk.com
• Zendesk-API-Community

Aktivieren des Kennwort- oder Tokenzugriffs

1. Gehen Sie in Zendesk Support zu Admin > Kanäle > API.
2. Aktivieren Sie den Kennwort- oder Tokenzugriff in der Registerkarte „Einstellungen“.

Generieren und Verwalten von API-Token

1. Gehen Sie in Zendesk Support zu Admin > Kanäle > API und klicken Sie auf die Registerkarte „Einstellungen“.
2. Um ein Token zu generieren, klicken Sie rechts auf das Pluszeichen (+).
3. Um ein Token zu löschen, klicken Sie in der Liste auf das entsprechende Token und dann rechts auf Löschen.

Es können mehrere Token gleichzeitig aktiv sein. Wenn Sie ein Token löschen, wird es dauerhaft deaktiviert.

Weitere Informationen finden Sie unter API tokens auf developer.zendesk.com.

Erstellen und Verwalten von OAuth-Clients

1. Gehen Sie in Zendesk Support zu Admin > Kanäle > API und klicken Sie auf die Registerkarte „OAuth-Clients“.
2. Erstellen Sie einen Client wie unter Registrieren Ihrer Anwendung bei Zendesk beschrieben.

Verfolgen der API-Aktivität und Vergleichen mit dem Ratenlimit

Sie können die Aktivität in der Core-API in den letzten 24 Stunden mit Ihrem Ratenlimit vergleichen. Gehen Sie in Zendesk Support zu Admin > Kanäle > API und klicken Sie auf die Registerkarte Aktivität.

Die folgenden Anfragen sind nicht in der Aktivität enthalten:

• Help Center und Talk API-Anfragen
• Anfragen, die die Sitzungsauthentifizierung nutzen, wie z. B. Anfragen von Zendesk-Apps oder clientseitige Anfragen von JavaScript-Code im Help Center
• Anonyme Anfragen, die keine Authentifizierung erfordern

Auf dieser Seite sehen Sie die Aktivität der letzten 24 Stunden. Das Diagramm stellt die Anfragen im Zeitverlauf dar, während aus der Tabelle die Gesamtzahl von Anfragen pro Client hervorgeht. Die Clients werden anhand der verwendeten Authentifizierungs-Credentials identifiziert. In der Tabelle sind die Namen – oder Identitäten – der API-Token, OAuth-Clients und Benutzer zur grundlegenden Authentifizierung aufgeführt.

Das Diagramm wird bei reger Aktivität entsprechend skaliert. Dadurch kann die Linie für das Ratenlimit verschwinden. Wenn genügend Aktivität stattfindet, erscheint an der Markierung für 700 Anfragen eine horizontale Linie für das Ratenlimit.

Die horizontale Stundenskala erscheint in der jeweiligen Ortszeit. Die Markierung ganz rechts ist die aktuelle Stunde.

Unter Anfragespitzen erscheint die höchste Anzahl von Anfragen, die während der Stunde innerhalb einer Minute eingingen. Unter Durchschnittliche Anfragen/Min. erscheint die durchschnittliche Anzahl von Anfragen pro Minute während der jeweiligen Stunde.

Hinweis: In dieser Grafik sind die für bestimmte Endpunkte wie Incremental Exports geltenden Ratenlimits nicht berücksichtigt.

Abrufen von Informationen zu HTTP- und URL-Zielfehlern

Wenn Sie Probleme mit einem HTTP- oder URL-Ziel haben, können Sie die Informationen aufrufen, die vom Drittanbieterdienst oder der REST-API zurückgegeben werden, auf den bzw. die das Ziel zuzugreifen versuchte. Klicken Sie in Zendesk Support auf Admin > Kanäle > API und dann auf die Registerkarte Zielfehler. Beispiel:

Klicken Sie auf einen Listeneintrag, um weitere Informationen zu dem betreffenden Fehler anzuzeigen.

Hinweis: Die Fehlerinformationen stammen aus der vom Drittanbieterdienst zurückgegebenen Antwort. Wenn Sie Hilfe bei der Fehlerbehebung brauchen, schlagen Sie in der Dokumentation des jeweiligen Dienstes nach.