Die Blue API verwendet ein tokenbasiertes Authentifizierungssystem.


Bevor Sie Abfragen ausführen, ist es wichtig, die Header für Ihre API-Anfrage einzurichten. Diese Header bleiben bei allen Anfragen konsistent und erfordern nur eine einmalige Einrichtung. Sie dienen dazu, jede Anfrage an die API zu authentifizieren.

Die erforderlichen Header sind die Token-ID und die Secret-ID, dargestellt als x-bloo-token-id und x-bloo-token-secret.

Zusätzlich kann es erforderlich sein, bei bestimmten Anfragen eine Unternehmens-ID x-bloo-company-id und eine Projekt-ID x-bloo-project-id für spezifischere Operationen einzufügen.

Sie können in folgendem Video lernen, wie Sie ein Token und ein Secret erstellen:

Token-ID

Die Token-ID ist Ihr eindeutiger Identifikator für den API-Zugriff.

Um unsere API zu nutzen, klicken Sie oben rechts auf Ihr Profil, und im Profilmenü finden Sie den API-Tab.

API 2

Im API-Tab klicken Sie auf die Schaltfläche "Token generieren":

API 3

Geben Sie einen Namen für das Token an und setzen Sie ein Ablaufdatum, falls gewünscht. Wenn Sie ein Ablaufdatum festlegen, wird das API-Token nach diesem Datum automatisch nicht mehr funktionieren.

API 4

Nach der Generierung wird Ihnen eine Token-ID und eine Secret-ID angezeigt. Die Token-ID wird mit pat_ zur einfachen Identifizierung vorangestellt.

Secret-ID

Die Secret-ID fungiert als Passwort und gewährleistet eine sichere Kommunikation mit der Blue API.

Denken Sie daran, dass die Secret-ID aus Sicherheitsgründen nur einmal angezeigt wird. Bewahren Sie sie sicher auf, um den Zugriff auf Ihre Daten über die API zu gewährleisten. Für maximale Sicherheit speichert Blue Ihr Secret mit bcrypt-Hashing, was bedeutet, dass selbst unser Team Ihr Klartext-Secret nach der Erstellung nicht abrufen kann.

API 5

Sicherheitswarnung


Stellen Sie sicher, dass Sie Ihre Token-ID und Secret-ID sicher aufbewahren, da jeder, der Zugriff auf diese Anmeldeinformationen hat, auf Ihre Daten in Blue zugreifen kann.

Unternehmens- und Projekt-IDs

Hier ist ein Video, das zeigt, wie Sie Ihre Unternehmens-ID und Projekt-ID in Blue finden:

Unternehmen sind die oberste Entität in Blue. Unternehmens-IDs werden verwendet, um ein Unternehmen in Blue zu identifizieren. Sie werden in der API verwendet, um anzugeben, mit welchem Unternehmen interagiert werden soll. Die ID ist dieselbe wie der Unternehmens-Slug in der URL, wenn Sie das Unternehmen in Blue besuchen:

app.blue.cc/company/{company-id}/

Für bestimmte Abfragen und Mutationen müssen Sie eine Projekt-ID angeben. Dies ist die ID des Projekts, mit dem Sie interagieren möchten. Die ID ist dieselbe wie der Projekt-Slug in der URL, wenn Sie das Projekt in Blue besuchen:

app.blue.cc/company/{company-id}/project/{project-id}/

KI-Assistent

Antworten werden mit KI generiert und können Fehler enthalten.

Wie kann ich Ihnen helfen?

Fragen Sie mich alles über Blue oder diese Dokumentation.

Eingabe zum Senden • Shift+Eingabe für neue Zeile • ⌘I zum Öffnen