De Blue API maakt gebruik van een op tokens gebaseerde authenticatiesysteem.
Headers
Voordat je queries uitvoert, is het essentieel om de headers voor je API-verzoek in te stellen. Deze headers blijven consistent voor alle verzoeken en vereisen slechts een eenmalige setup. Ze dienen om elk verzoek aan de API te authentiseren.
De vereiste headers zijn de Token-ID en Secret-ID, respectievelijk weergegeven als x-bloo-token-id en x-bloo-token-secret.
Bovendien kunnen bepaalde verzoeken de toevoeging van een Company-ID x-bloo-company-id en Project-ID x-bloo-project-id vereisen voor meer specifieke operaties.
Je kunt leren hoe je een token en geheim kunt aanmaken in de volgende video:
Token ID
De Token ID is jouw unieke identificatie voor API-toegang.
Om onze API te gaan gebruiken, klik je op je profiel rechtsboven, en onder het profielmenu vind je het API-tabblad.
In het API-tabblad klik je op de knop "Genereer een Token":
Geef een naam voor het token op en stel een vervaldatum in als je dat wilt. Als je een vervaldatum instelt, stopt de API-token automatisch met werken na die datum.
Na generatie krijg je een Token ID en een Secret ID te zien. De Token ID wordt voorafgegaan door pat_ voor gemakkelijke identificatie.
Secret ID
De Secret ID fungeert als een wachtwoord en zorgt voor veilige communicatie met de API van Blue.
Vergeet niet dat de Secret ID slechts één keer wordt weergegeven om veiligheidsredenen, dus bewaar deze veilig om toegang tot je gegevens via de API te behouden. Voor maximale veiligheid slaat Blue je geheim op met bcrypt-hashing, wat betekent dat zelfs ons team je platte tekst geheim niet kan terughalen na creatie.
Zorg ervoor dat je je Token ID en Secret ID veilig houdt, want iedereen met toegang tot deze inloggegevens kan toegang krijgen tot je gegevens in Blue.
Company & Project IDs
Hier is een video die laat zien hoe je je company ID en project ID in Blue kunt vinden:
Bedrijven zijn de top-level entiteit in Blue. Company IDs worden gebruikt om een bedrijf in Blue te identificeren. Ze worden in de API gebruikt om aan te geven met welk bedrijf je wilt communiceren. De ID is hetzelfde als de company slug in de URL wanneer je het bedrijf in Blue bezoekt:
app.blue.cc/company/{company-id}/
Voor bepaalde queries en mutaties moet je een Project ID opgeven. Dit is de ID van het project waarmee je wilt communiceren. De ID is hetzelfde als de project slug in de URL wanneer je het project in Blue bezoekt:
app.blue.cc/company/{company-id}/project/{project-id}/