zendesk-app-request-api

eesel Team
Written by

eesel Team

Last edited March 2, 2026

{
  "title": "Zendesk App Request API: Ein vollständiger Entwicklerleitfaden für 2026",
  "slug": "zendesk-app-request-api",
  "locale": "de",
  "date": "2026-03-02",
  "updated": "2026-03-02",
  "template": "default",
  "excerpt": "Ein umfassender Leitfaden für das Stellen von API-Anfragen von Zendesk-Apps, einschließlich der ZAF request() Methode, Authentifizierungsoptionen und praktischen Codebeispielen.",
  "categories": [
    "Zendesk",
    "Guides"
  ],
  "tags": [
    "Zendesk API",
    "ZAF",
    "App-Entwicklung",
    "API-Anfragen",
    "Kundensupport"
  ],
  "readTime": 10,
  "author": 16,
  "reviewer": 14,
  "seo": {
    "title": "Zendesk App Request API: Ein vollständiger Entwicklerleitfaden für 2026",
    "description": "Ein umfassender Leitfaden für das Stellen von API-Anfragen von Zendesk-Apps, einschließlich der ZAF request() Methode, Authentifizierungsoptionen und praktischen Codebeispielen.",
    "image": "https://wmeojibgfvjvinftolho.supabase.co/storage/v1/object/public/public_assets/blog-gen/banner-4483d692-7065-4621-b1b0-bb0853f480f2"
  },
  "coverImage": "https://wmeojibgfvjvinftolho.supabase.co/storage/v1/object/public/public_assets/blog-gen/banner-4483d692-7065-4621-b1b0-bb0853f480f2",
  "coverImageAlt": "Bannerbild für Zendesk App Request API: Ein vollständiger Entwicklerleitfaden für 2026",
  "coverImageWidth": 1920,
  "coverImageHeight": 1080,
  "faqs": {
    "heading": "Häufig gestellte Fragen",
    "type": "blog",
    "answerType": "html",
    "faqs": [
      {
        "question": "Wofür wird die Zendesk App Request API verwendet?",
        "answer": "Die Zendesk App Request API bezieht sich auf zwei Dinge: die ZAF Client request() Methode zum Tätigen von HTTP-Aufrufen innerhalb von Zendesk-Apps und den Requests API-Endpunkt für Endbenutzer zum Erstellen und Anzeigen von Tickets. Beide ermöglichen die programmgesteuerte Interaktion mit Zendesk-Daten."
      },
      {
        "question": "Wie authentifiziere ich Zendesk App Request API-Aufrufe?",
        "answer": "Die Authentifizierung hängt von Ihrem Anwendungsfall ab. Für Aufrufe innerhalb einer Zendesk-App verwendet der ZAF-Client automatisch Browser-Cookies. Für externe API-Aufrufe verwenden Sie die Standardauthentifizierung (Basic Auth) mit Ihrem E-Mail-/Token:api_token-Format, Base64-kodiert mit einem Präfix 'Basic '."
      },
      {
        "question": "Kann ich die Zendesk App Request API zum Hochladen von Dateien verwenden?",
        "answer": "Die ZAF request() Methode unterstützt keine binären Datei-Uploads. Für Dateianhänge müssen Sie einen Workaround verwenden, z. B. das Kodieren von Dateien als Base64, die Verwendung eines separaten Upload-Dienstes oder die Implementierung einer serverseitigen Verarbeitung."
      },
      {
        "question": "Was sind die Ratenbegrenzungen für die Zendesk App Request API?",
        "answer": "Zendesk wendet zwei Ratenbegrenzungen an: eine Apps-Ratenbegrenzung (in der Regel 100 Anfragen pro Minute pro App) und eine Konto-Ratenbegrenzung (700 Anfragen pro Minute für die meisten Endpunkte). Das Überschreiten einer der beiden Grenzen gibt einen 429-Status mit einem Retry-After-Header zurück."
      },
      {
        "question": "Wie verberge ich API-Schlüssel in meiner Zendesk-App?",
        "answer": "Verwenden Sie sichere Einstellungen in Ihrer manifest.json. Markieren Sie Parameter als 'secure': true, referenzieren Sie sie mit {{setting.param_name}} in Ihrem Code und konfigurieren Sie sie während der App-Installation. Die tatsächlichen Werte werden serverseitig gespeichert und niemals im Browser angezeigt."
      },
      {
        "question": "Was ist der Unterschied zwischen der Requests API und der Tickets API in Zendesk?",
        "answer": "Die Requests API ist für Endbenutzer konzipiert und zeigt nur öffentliche Kommentare und zugängliche Felder an. Die Tickets API ist für Agenten und Administratoren mit vollem Zugriff. Verwenden Sie die Requests API für kundenorientierte Funktionen und die Tickets API für interne Tools."
      },
      {
        "question": "Kann ich direkte API-Aufrufe tätigen, ohne den ZAF-Proxy zu verwenden?",
        "answer": "Ja, indem Sie cors: true in Ihren Anfrageoptionen festlegen. Die Ziel-API muss jedoch CORS-Header unterstützen. Die meisten Produktions-Apps verwenden den Proxy aus Gründen der Zuverlässigkeit, da er mit jeder API funktioniert."
      }
    ],
    "supportLink": null
  }
}
---

Wenn Sie eine Zendesk-App entwickeln, müssen Sie irgendwann API-Anfragen stellen. Vielleicht ziehen Sie Daten von einem externen Dienst, erstellen Tickets programmgesteuert oder integrieren sich in eine andere Plattform. Die Zendesk App Request API bietet Ihnen verschiedene Möglichkeiten, dies zu tun, aber die Dokumentation ist auf mehrere Seiten verteilt und die Authentifizierungsoptionen können verwirrend sein.

Dieser Leitfaden fasst alles zusammen, was Sie über das Stellen von API-Anfragen von Zendesk-Apps wissen müssen. Wir werden die ZAF Client request() Methode, den Requests API-Endpunkt, Authentifizierungsstrategien und häufige Fallstricke behandeln, auf die Entwickler stoßen. Wenn Sie nach einer einfacheren Möglichkeit suchen, Zendesk-Workflows zu automatisieren, ohne benutzerdefinierten Code zu schreiben, werden wir auch darauf eingehen, wie [eesel AI in Zendesk integriert](https://www.eesel.ai/integration/zendesk-ai) ist, um die Ticketverwaltung durch KI-Agenten zu übernehmen.

![Konfigurationsschnittstelle für einen ZAF-Client, der das apiToken-Feld für die Authentifizierung anzeigt](https://zen-marketing-documentation.s3.amazonaws.com/docs/en/zaf-secure-setting-prompt.png)

## Was ist die Zendesk App Request API?

Wenn Entwickler nach "Zendesk App Request API" suchen, suchen sie in der Regel nach einem von zwei Dingen:

1. **Die ZAF Client request() Methode** - Eine JavaScript-Funktion, mit der Ihre Zendesk-App HTTP-Anfragen an externe APIs oder die Zendesk API selbst stellen kann
2. **Der Requests API-Endpunkt** - Eine REST-API, mit der Endbenutzer Tickets aus ihrer Perspektive erstellen und anzeigen können

Die ZAF request() Methode verwenden Sie, wenn Sie Apps entwickeln, die in Zendesk ausgeführt werden. Sie übernimmt die Authentifizierung, vermeidet Cross-Domain-Beschränkungen und verwaltet die Komplexität des Tätigens sicherer API-Aufrufe aus einer Browserumgebung. Die Requests API rufen Sie auf, wenn Sie Kunden Tickets einreichen lassen möchten, ohne ihnen vollen Agentenzugriff zu gewähren.

Lassen Sie uns aufschlüsseln, wie die einzelnen Methoden funktionieren und wann Sie sie verwenden sollten.

![Architekturdiagramm, das die sichere Kommunikationsweiterleitung externer Anfragen über einen Proxy zeigt, um browserbasierte Cross-Origin-Sicherheitsfehler zu verhindern](https://wmeojibgfvjvinftolho.supabase.co/storage/v1/object/public/public_assets/blog-gen/c05a29e0-b886-463b-9866-b734cad88004)

## Die ZAF Client request() Methode verstehen

Das [Zendesk Apps Framework (ZAF)](https://developer.zendesk.com/api-reference/apps/introduction/) bietet einen JavaScript-Client, der in Ihrer App ausgeführt wird. Die `client.request()` Methode ist Ihr Gateway zum Tätigen von HTTP-Anfragen aus der Zendesk-Umgebung heraus.

Hier ist der Grund, warum es sie gibt: Browser blockieren aus Sicherheitsgründen Cross-Origin-Anfragen. Wenn Ihre App versucht, eine externe API direkt aufzurufen, treten CORS-Fehler auf. ZAF löst dies, indem es Ihre Anfragen über einen Zendesk-Proxyserver leitet. Der Proxy stellt die eigentliche Anfrage und gibt die Antwort an Ihre App zurück.

Die request() Methode gibt ein JavaScript-Promise zurück, sodass Sie Antworten mit `.then()` oder `async/await` verarbeiten:

```javascript
const client = ZAFClient.init();

client.request({
  url: 'https://api.example.com/data',
  type: 'GET',
  headers: {
    'Authorization': 'Bearer {{setting.api_token}}'
  }
}).then(data => {
  console.log('Response:', data);
}).catch(error => {
  console.error('Error:', error);
});

Hauptfunktionen der request() Methode:

  • Proxy-Server-Routing - Vermeidet CORS, indem Anfragen serverseitig gestellt werden
  • Sichere Einstellungen - Verbergen Sie API-Schlüssel vor Browser-Entwicklungstools mithilfe von manifest.json-Platzhaltern
  • OAuth-Token-Verwaltung - Verwalten Sie OAuth-Abläufe von Drittanbietern, ohne Token preiszugeben
  • JWT-Kodierung - Signieren Sie Anfragen mit JSON Web Tokens für zusätzliche Sicherheit

Eine Einschränkung ist zu beachten: Die request() Methode unterstützt keine binären Datei-Uploads. Wenn Sie Dateien anhängen müssen, müssen Sie einen anderen Ansatz verwenden (mehr dazu später).

Installationsschnittstelle, die ein apiToken-Feld zur Authentifizierung von API-Anfragen von Drittanbietern anzeigt
Installationsschnittstelle, die ein apiToken-Feld zur Authentifizierung von API-Anfragen von Drittanbietern anzeigt

Authentifizierungsmethoden für Zendesk App-Anfragen

Die Authentifizierung ist der Punkt, an dem die meisten Entwickler stecken bleiben. Zendesk bietet mehrere Authentifizierungsmethoden an, und die Wahl der richtigen Methode hängt davon ab, was Sie erreichen möchten.

Standardauthentifizierung (Basic Authentication) mit API-Token

Der einfachste Ansatz zum Aufrufen der Zendesk API selbst. Formatieren Sie Ihre Anmeldeinformationen als {email}/token:{api_token}, Base64-kodieren Sie sie und fügen Sie sie mit dem Präfix "Basic " in den Authorization-Header ein:

const credentials = btoa('agent@company.com/token:abc123xyz');
const authHeader = `Basic ${credentials}`;

Häufiger Fehler: Vergessen des Präfixes "Basic ". Der Header muss mit "Basic " gefolgt von einem Leerzeichen beginnen, dann die Base64-kodierte Zeichenfolge. Viele Entwickler kodieren die Anmeldeinformationen korrekt, lassen aber das Präfix weg, was zu 401 Unauthorized-Fehlern führt.

Sichere Einstellungen

Wenn Sie eine API eines Drittanbieters aufrufen, möchten Sie API-Schlüssel nicht in Ihrem JavaScript preisgeben, wo jeder sie in der Browserkonsole sehen kann. Sichere Einstellungen lösen dies, indem sie sensible Daten serverseitig speichern.

In Ihrer manifest.json:

{
  "parameters": [
    {
      "name": "api_token",
      "type": "text",
      "secure": true
    }
  ],
  "domainWhitelist": ["api.example.com"]
}

Referenzieren Sie die Einstellung in Ihrem Code mit doppelten geschweiften Klammern:

headers: {
  'Authorization': 'Bearer {{setting.api_token}}'
}

Der tatsächliche Tokenwert wird auf den Servern von Zendesk gespeichert und zum Zeitpunkt der Anfrage eingefügt. Benutzer konfigurieren ihn während der App-Installation, und er wird niemals im Browser angezeigt.

Sichere Einstellungsarchitektur, die API-Token auf Zendesk-Servern und außerhalb der Browserkonsole des Benutzers speichert
Sichere Einstellungsarchitektur, die API-Token auf Zendesk-Servern und außerhalb der Browserkonsole des Benutzers speichert

OAuth 2.0

Für Integrationen mit Diensten wie Salesforce, Slack oder Google ist OAuth der Standard. ZAF unterstützt den Autorisierungscode-Ablauf:

  1. Ihre App leitet den Benutzer zum OAuth-Anbieter weiter
  2. Der Benutzer autorisiert den Zugriff
  3. Der Anbieter leitet mit einem Autorisierungscode zurück
  4. Ihre App tauscht den Code gegen ein Zugriffstoken aus
  5. ZAF speichert das Token sicher und aktualisiert es automatisch

Die Einrichtung erfordert die Registrierung Ihrer App beim OAuth-Anbieter und die Konfiguration der Weiterleitungs-URLs. Nach der Einrichtung wird die Tokenverwaltung automatisch übernommen.

JWT-Token

Für signierte Anfragen unterstützt ZAF die JWT-Kodierung mit dem HS256-Algorithmus. Sie stellen einen geheimen Schlüssel bereit, und ZAF generiert Token mit Ansprüchen wie der Ablaufzeit. Dies ist nützlich, wenn Sie überprüfen müssen, ob Anfragen von Ihrer Zendesk-App stammen und nicht manipuliert wurden.

Browser-Cookie-Authentifizierung

Wenn Sie die Zendesk API aus Ihrer App heraus aufrufen, können Sie die explizite Authentifizierung vollständig überspringen. Der ZAF-Client verwendet automatisch das Zendesk-Sitzungscookie des Browsers, um Anfragen zu authentifizieren. Dies funktioniert nur für Zendesk API-Endpunkte, nicht für externe APIs.

Welche Authentifizierungsmethode sollten Sie verwenden?

SzenarioEmpfohlene Methode
Zendesk API aus Ihrer App aufrufenBrowser-Cookies (automatisch)
Zendesk API aus externem Code aufrufenStandardauthentifizierung (Basic Auth) mit API-Token
APIs von Drittanbietern aufrufenSichere Einstellungen oder OAuth
Benötigen signierte/verifizierte AnfragenJWT

Weitere Informationen zur Arbeit mit Zendesk APIs finden Sie in unserem Leitfaden zur Zendesk Ticket API.

Anfragen an APIs von Drittanbietern stellen

Standardmäßig leitet ZAF Anfragen über seinen Proxyserver weiter. Dies wird durch die Option cors gesteuert:

// Standardverhalten - verwendet Proxy (cors: false)
client.request({
  url: 'https://api.example.com/data',
  type: 'GET'
});

// Direkte Anfrage - erfordert CORS-Unterstützung auf der API
client.request({
  url: 'https://api.example.com/data',
  type: 'GET',
  cors: true
});

Der Proxy-Ansatz funktioniert mit jeder API, fügt aber Latenz hinzu. Direkte Anfragen sind schneller, erfordern aber, dass die API CORS-Header unterstützt. Die meisten Produktions-Apps verwenden den Proxy aus Gründen der Zuverlässigkeit.

Hier ist ein vollständiges funktionierendes Beispiel, das Daten von einer externen API mithilfe sicherer Einstellungen abruft:

const client = ZAFClient.init();

async function fetchCustomerData(customerId) {
  try {
    const response = await client.request({
      url: `https://api.example.com/customers/${customerId}`,
      type: 'GET',
      headers: {
        'Authorization': 'Bearer {{setting.api_key}}',
        'Content-Type': 'application/json'
      }
    });

    return response;
  } catch (error) {
    console.error('Failed to fetch customer:', error);
    throw error;
  }
}

Die Fehlerbehandlung ist wichtig. Das Promise wird abgelehnt, wenn die Anfrage fehlschlägt, also umschließen Sie Aufrufe immer mit try/catch oder verwenden Sie .catch().

Arbeiten mit der Zendesk Requests API

Die Requests API ist von der ZAF request() Methode getrennt. Es handelt sich um einen REST-API-Endpunkt, mit dem Endbenutzer (Kunden) aus ihrer Perspektive mit Tickets interagieren können.

Hauptunterschiede zur Tickets API:

  • Endbenutzeransicht - Sieht nur öffentliche Kommentare und Felder, auf die der Benutzer Zugriff hat
  • Anonymer Support - Kann ohne Authentifizierung aufgerufen werden (ratenbegrenzt)
  • Vereinfachte Berechtigungen - Keine Agentenanmeldeinformationen erforderlich

Häufige Endpunkte:

EndpunktMethodeBeschreibung
/api/v2/requestsGETAnfragen für den authentifizierten Benutzer auflisten
/api/v2/requestsPOSTEine neue Anfrage (Ticket) erstellen
/api/v2/requests/{id}GETDetails einer bestimmten Anfrage abrufen
/api/v2/requests/{id}PUTEine bestehende Anfrage aktualisieren

Eine Anfrage erstellen:

curl https://company.zendesk.com/api/v2/requests.json \
  -d '{"request": {"subject": "Hilfe benötigt", "comment": {"body": "Ich habe eine Frage"}}}' \
  -H "Content-Type: application/json" \
  -X POST

Fügen Sie für authentifizierte Anfragen den Authorization-Header hinzu. Lassen Sie für anonyme Anfragen (wie ein Kontaktformular) die Authentifizierung weg. Anonyme Anfragen sind auf 5 pro Stunde für Testkonten begrenzt.

Wenn Sie Integrationen erstellen, die Tickets erstellen, finden Sie möglicherweise auch unseren Leitfaden zum Erstellen von Zendesk-Tickets mithilfe der API hilfreich.

Häufige Fehler und Fehlerbehebung

Auch mit guter Dokumentation geht etwas schief. Hier sind die häufigsten Probleme, auf die Entwickler stoßen:

401 Nicht autorisiert

Der Authentifizierungsheader ist fehlerhaft. Überprüfen Sie Folgendes:

  • Das Präfix "Basic " ist vorhanden (mit einem Leerzeichen dahinter)
  • Die Anmeldeinformationen sind korrekt Base64-kodiert
  • Das E-Mail-Format ist {email}/token:{api_token} (beachten Sie das Suffix "/token")
  • Das API-Token ist aktiv und nicht abgelaufen

CORS-Fehler

Sie versuchen, eine direkte Anfrage an eine API zu stellen, die CORS nicht unterstützt. Aktivieren Sie entweder den Proxy, indem Sie cors: true weglassen, oder bitten Sie den API-Anbieter, CORS-Header hinzuzufügen.

429 Ratenlimit überschritten

Zendesk hat mehrere Ratenbegrenzungen. Apps haben ihre eigene Begrenzung (normalerweise 100 Anfragen pro Minute), und Ihr Konto hat eine separate Begrenzung (700 Anfragen pro Minute für die meisten Endpunkte). Wenn Sie einen 429 erhalten, überprüfen Sie den Retry-After-Header und warten Sie, bevor Sie es erneut versuchen. Die vollständigen Details finden Sie in der offiziellen Dokumentation zu Ratenbegrenzungen.

422 Nicht verarbeitbare Entität

Ihr JSON ist fehlerhaft. Häufige Ursachen:

  • Fehlende Anführungszeichen um Eigenschaftsnamen
  • Nachgestellte Kommas in Objekten
  • Einfache Anführungszeichen anstelle von doppelten Anführungszeichen
  • Ungültige Escape-Sequenzen

Probleme beim Hochladen von Dateien

Die ZAF request() Methode unterstützt keine binären Uploads. Workarounds sind:

  • Verwenden eines separaten Servers zur Verarbeitung von Uploads
  • Kodieren von Dateien als Base64 und Dekodieren serverseitig
  • Verwenden einer Bibliothek wie RestSharp für die binäre Verarbeitung

Weitere Integrationsbeispiele finden Sie in unserem Leitfaden zum Verbinden von Zendesk mit Slack mithilfe von Drittanbieter-Apps.

Diagnose-Flussdiagramm, das Entwicklern hilft, häufige Authentifizierungs- und Konfigurationsfehler in der Zendesk-App-Entwicklung zu identifizieren und zu beheben
Diagnose-Flussdiagramm, das Entwicklern hilft, häufige Authentifizierungs- und Konfigurationsfehler in der Zendesk-App-Entwicklung zu identifizieren und zu beheben

Erstellen von Zendesk App-Integrationen ohne Code

Benutzerdefinierte API-Integrationen benötigen Zeit für die Erstellung und Wartung. Sie müssen die Authentifizierung, die Logik für die Wiederholung von Fehlern, die Ratenbegrenzung und die laufende Wartung verwalten, wenn sich APIs ändern.

Wenn Ihr Ziel darin besteht, Ticket-Workflows zu automatisieren, anstatt eine benutzerdefinierte App zu erstellen, sollten Sie überlegen, ob Sie tatsächlich Code schreiben müssen. Unser KI-Agent für Zendesk übernimmt die Ticketerstellung, das Routing und die Antworten ohne Entwicklungsaufwand.

eesel AI-Dashboard zum Konfigurieren des Supervisor-Agenten als No-Code-Alternative zu komplexen Subagent-Tools
eesel AI-Dashboard zum Konfigurieren des Supervisor-Agenten als No-Code-Alternative zu komplexen Subagent-Tools

Hier ist der Unterschied: Mit dem API-Ansatz schreiben Sie Skripte, um Tickets zu verschieben, auf die Menschen immer noch antworten müssen. Mit einem KI-Agenten trainieren Sie ein System, um Ihr Unternehmen zu verstehen und den gesamten Ticket-Lebenszyklus zu verwalten. Sie verbinden es mit Ihrem Zendesk-Konto und es lernt aus Ihren vergangenen Tickets, Hilfeartikel und Makros.

Das progressive Rollout-Modell bedeutet, dass Sie damit beginnen, dass die KI Entwürfe für Antworten zur Überprüfung erstellt, und dann auf die vollständige Automatisierung ausweiten, sobald sie sich bewährt hat. Für Teams, die das Ticketvolumen reduzieren und nicht nur API-Aufrufe automatisieren möchten, liefert dies oft schnellere Ergebnisse als die benutzerdefinierte Entwicklung.

Diesen Beitrag teilen

eesel undefined

Article by

eesel Team