QamaqQamaq

Qamaq API-Dokumentation

Erstellen Sie leistungsstarke Integrationen mit der Qamaq API. Greifen Sie auf Entitäten, Wissensdatenbank, Workflows und mehr zu.

Schnellstart

1

Ihren API-Schlüssel erhalten

Navigieren Sie zu Konfigurationen > API-Schlüssel in Ihrem Qamaq-Dashboard, um einen neuen API-Schlüssel zu erstellen. Kopieren Sie ihn sofort, da er nicht erneut angezeigt wird.

2

Ihre erste Anfrage senden

Verwenden Sie Ihren API-Schlüssel im Authorization-Header mit dem Bearer-Schema:

Beispielanfragebash
curl -X GET "https://api.qamaq.io/api/v1/entities" \
  -H "Authorization: Bearer qmq_your_api_key"
3

Die API erkunden

Durchsuchen Sie unsere API-Referenz unten, um alle verfügbaren Endpunkte und Funktionen zu entdecken.

API-Funktionen

API-Schlüssel-Authentifizierung

Sichern Sie Ihre Anfragen mit API-Schlüsseln und Bearer-Token-Authentifizierung.

Boards

Zugriff auf und Verwaltung von Kanban-Boards mit Spalten und Workflow-Phasen.

Tickets

Erstellen, aktualisieren, verschieben und verwalten Sie Tickets auf Ihren Kanban-Boards.

Benutzerdefinierte Entitäten

Erstellen, lesen, aktualisieren und löschen Sie benutzerdefinierte Entitäten und deren Datensätze.

Ordner

Organisieren Sie Ihre Wissensdatenbank mit Ordnern und hierarchischen Strukturen.

Dateien

Hochladen, verwalten und abrufen von Dateien in Ihrer Wissensdatenbank.

Semantische Suche

Führen Sie KI-gestützte semantische Suche über Ihre Wissensdatenbank durch.

Webhooks

Konfigurieren Sie Webhooks, um Echtzeit-Ereignisbenachrichtigungen zu erhalten.

Basis-URL

Alle API-Anfragen sollten an folgende Adresse gerichtet werden:

https://api.qamaq.io/api/v1

API-Versionierung

Die API-Version ist im URL-Pfad enthalten. Die aktuelle stabile Version ist v1.

Wir kündigen alle Breaking Changes rechtzeitig im Voraus an und wahren die Abwärtskompatibilität, wo immer möglich.

Rate-Limiting

Die API implementiert Rate-Limiting, um eine faire Nutzung zu gewährleisten. Aktuelle Limits:

1000

Anfragen/Minute

10,000

Anfragen/Stunde

100,000

Anfragen/Tag

Hinweis: Rate-Limit-Header sind in allen Antworten enthalten. Wenn Sie das Limit überschreiten, erhalten Sie eine 429-Antwort (Zu viele Anfragen). Kontaktieren Sie uns, wenn Sie höhere Limits benötigen.

Fehlerbehandlung

Die API verwendet Standard-HTTP-Statuscodes, um Erfolg oder Fehlschlag von Anfragen anzuzeigen:

200OKAnfrage erfolgreich
201ErstelltRessource erfolgreich erstellt
400Ungültige AnfrageUngültige Anfrageparameter
401Nicht autorisiertFehlender oder ungültiger API-Schlüssel
403VerbotenAPI-Schlüssel hat nicht die erforderlichen Berechtigungen
404Nicht gefundenRessource nicht gefunden
422ValidierungsfehlerAnfragevalidierung fehlgeschlagen
429Zu viele AnfragenRate-Limit überschritten
500ServerfehlerInterner Serverfehler

Brauchen Sie Hilfe?

Unser Team steht Ihnen bei der Integration mit der Qamaq API zur Verfügung.

Support kontaktierenDokumentation ansehen