Best Practices für die Verwendung von cURL mit der API

Hinweis: cURL ist kein öffentlich unterstützter API-Client wie der in unserer API-Client-Liste . Zendesk bietet daher eingeschränkten Support.

In der Zendesk-API-Dokumentation wird cURL als Beispiel-API-Client verwendet, mit dem Sie API-Anforderungen schnell testen können. Anweisungen zum Einstieg in cURL finden Sie unter Installieren und Verwenden von cURL . In diesem Beitrag beschreiben wir Best Practices zum Testen von API-Anforderungen mit cURL.

Hinweis: Wenn Sie eines dieser Beispiele verwenden möchten, müssen Sie es ersetzen {{mysubdomain}} ,, {{[e-mail]}} und {{mypassword}} durch Ihre Subdomäne, Ihre E-Mail-Adresse und Ihr Kennwort. Wenn Sie zur Authentifizierung Ihrer API-Aufrufe ein Kennwort anstelle eines Tokens verwenden möchten, müssen Sie in den API-Einstellungen die Kennwortauthentifizierung aktivieren.

Verwenden Sie beim Testen von API-Aufrufen die folgenden Best Practices:

• Zitieren Sie Ihre URLs
• Escape-Sonderzeichen
• Ziehen Sie eine andere Testmethode in Betracht

Zitieren Sie Ihre URLs

Durch Angabe der URL, die Sie erreichen möchten, werden unerwartete Fehler mit cURL vermieden. Betrachten Sie das folgende Beispiel:

curl https://{{mysubdomain}}.zendesk.com/api/v2/incremental/tickets.json?start_time=1&include=metric_sets -v -u {{[e-mail]}}:{{mypassword}}

Wenn Sie diesen Code in der Befehlszeilenoberfläche einfügen, erscheint der Fehler „Befehl nicht gefunden“, der durch die Sonderzeichen in den URL-Parametern verursacht wird. Die Lösung besteht darin, die gesamte URL in Anführungszeichen zu setzen, bevor Sie den Befehl ausführen. Beispiel:

curl "https://{{mysubdomain}}.zendesk.com/api/v2/incremental/tickets.json?start_time=1&include=metric_sets" -v -u {{[e-mail]}}:{{mypassword}}

Escape-Sonderzeichen

Beim Authentifizieren von cURL-Aufrufen mit dem Parameter -u oder --user können Sie eine E-Mail-Adresse und ein Kennwort angeben. Dieser Parameter kann nicht in Anführungszeichen gesetzt werden. Wenn Ihr Terminal auf Bash basiert und Sie ein Kennwort mit Ausrufezeichen eingeben, sieht bash dies als separaten Befehl und führt zu unerwartetem Verhalten. Die Lösung besteht darin, dem Zeichen einen Backslash als Escape-Zeichen hinzuzufügen.

Schlecht: -u sa! Sa

Gut: -u sa \! Sa

Ziehen Sie eine andere Testmethode in Betracht

Bei Verwendung der API kann es zu unerwarteten Ergebnissen kommen. Wenn Sie sich mit Ihrer API-Anfrage an das Kundensupportteam von Zendesk wenden, bitten wir Sie möglicherweise um konkrete Angaben zum API-Aufruf. Sie können ein anderes API-Testtool wie Postman verwenden , um weitere Details zu Ihrer API-Anfrage zu erhalten.

Hinweis zur Übersetzung: Dieser Beitrag wurde mit automatischer Übersetzungssoftware übersetzt, um dem Leser ein grundlegendes Verständnis des Inhalts zu vermitteln. Trotz angemessener Bemühungen, eine akkurate Übersetzung bereitzustellen, kann Zendesk keine Garantie für die Genauigkeit übernehmen.

Sollten in Bezug auf die Genauigkeit der Informationen im übersetzten Beitrag Fragen auftreten, beziehen Sie sich bitte auf die englische Version des Beitrags, die als offizielle Version gilt.