Blue API använder ett token-baserat autentiseringssystem.
Headers
Innan du utför några frågor är det viktigt att ställa in headers för din API-förfrågan. Dessa headers förblir konsekventa över alla förfrågningar och kräver endast en engångsinställning. De används för att autentisera varje förfrågan till API:et.
De nödvändiga headers är Token-ID och Secret-ID, representerade som x-bloo-token-id
och x-bloo-token-secret
respektive.
Dessutom kan vissa förfrågningar kräva att en Company-ID x-bloo-company-id
och Project-ID x-bloo-project-id
inkluderas för mer specifika operationer.
Du kan lära dig hur man skapar ett token och en hemlighet i följande video:
Token ID
Token-ID är din unika identifierare för API-åtkomst.
För att börja använda vår API, klicka på din profil uppe till höger, och under profilmenyn hittar du API-fliken.
I API-fliken, klicka på knappen "Generera ett Token":
Ange ett namn för token och ställ in ett utgångsdatum om så önskas. Om du ställer in ett utgångsdatum kommer API-token automatiskt att sluta fungera efter det datumet.
Efter generation kommer du att visas ett Token-ID och ett Secret-ID. Token-ID kommer att föregås av pat_
för enkel identifiering.
Secret ID
Secret-ID fungerar som ett lösenord och säkerställer säker kommunikation med Blue's API.
Kom ihåg att Secret-ID endast visas en gång av säkerhetsskäl, så spara det på ett säkert sätt för att behålla åtkomsten till dina data genom API:et. För maximal säkerhet lagrar Blue din hemlighet med bcrypt-hashing, vilket innebär att inte ens vårt team kan återfå din klara texthemlighet efter skapandet.
Se till att du håller ditt Token-ID och Secret-ID säkra, eftersom alla som har tillgång till dessa uppgifter kan få åtkomst till dina data i Blue.
Företags- och projekt-ID
Här är en video som visar hur du hittar ditt företags-ID och projekt-ID i Blue:
Företag är den översta enheten i Blue. Företags-ID används för att identifiera ett företag i Blue. De används i API:et för att specificera vilket företag som ska interageras med. ID:t är detsamma som företagets slug i URL:en när du besöker företaget i Blue:
app.blue.cc/company/{company-id}/
För vissa frågor och mutationer måste du ange ett Projekt-ID. Detta är ID:t för det projekt du vill interagera med. ID:t är detsamma som projektets slug i URL:en när du besöker projektet i Blue:
app.blue.cc/company/{company-id}/project/{project-id}/