Autentisering

Hver forespørsel trenger en API-nøkkel i headeren X-API-Key:

curl -H "X-API-Key: tel_AbCd1234_..." https://api.telescope.eco/external/properties/

Opprett en API-nøkkel

1. Logg inn i Telescope.
2. Åpne Kontoinnstillinger → API-nøkler.
3. Klikk Opprett API-nøkkel og gi den et navn som sier hvor den brukes, for eksempel Power BI - Økonomi eller Datavarehus.
4. Kopier hemmeligheten. Den vises bare én gang. Lagre den i en passordbehandler eller i plattformens hemmelighetslager.

En nøkkel ser ut som tel_AbCd1234_ etterfulgt av 32 bokstaver og sifre. Den første delen (tel_AbCd1234) er nøkkelens prefiks, som vises på siden API-nøkler slik at du kan skille nøklene fra hverandre. Telescope lagrer bare en hash av hemmeligheten, så en tapt hemmelighet kan ikke gjenopprettes. Roter nøkkelen i stedet.

Hvem sine data en nøkkel ser

En nøkkel tilhører brukeren som opprettet den, og handler på vegne av denne brukeren:

• Den ser dataene til brukerens organisasjon, og ingenting annet.
• Hvis brukeren flytter til en annen organisasjon, følger nøkkelen med.
• Hvis brukeren deaktiveres, slutter nøkkelen å virke.

Opprett derfor integrasjonsnøkler fra en konto som blir værende i organisasjonen, og gi hver integrasjon sin egen nøkkel. Da kan du rotere eller tilbakekalle nøkkelen til én integrasjon uten å påvirke de andre.

Alle organisasjoner kan lese. Opprettelse av eiendommer må i tillegg aktiveres for organisasjonen din av Telescope.

Roter, endre navn på eller tilbakekall en nøkkel

På siden API-nøkler kan du:

• Rotere en nøkkel (Roter API-nøkkel). Telescope lager en ny hemmelighet, og den gamle slutter å virke umiddelbart. Oppdater alle systemer som bruker nøkkelen, med en gang.
• Endre navnet på en nøkkel (Endre navn på API-nøkkel). Hemmeligheten er den samme.
• Tilbakekalle en nøkkel (Tilbakekall API-nøkkel). Forespørsler med den feiler fra da av.

Siden viser også når hver nøkkel sist ble brukt (Sist brukt), slik at du finner nøkler som ingenting bruker lenger.

Når autentiseringen feiler

En nøkkel som mangler, er feil, er rotert eller er tilbakekalt, gir 401 Unauthorized:

{ "detail": "Invalid API key.", "code": "authentication_failed" }

Uten headeren i det hele tatt er detail An API key must be included in X-API-Key.

Hold nøklene trygge

• Send nøkler bare til https://api.telescope.eco (eller staging). Legg dem aldri i URL-er, siden URL-er havner i logger.
• Ikke sjekk inn nøkler i versjonskontroll, og ikke lim dem inn i delte dokumenter.
• Alle som kan redigere en Power BI-fil som inneholder en nøkkel, kan lese den. Se sikkerhet i Power BI.
• Hvis en nøkkel kan ha lekket, roter den.