Autentisering
En integration har en egen roll och egna API-nycklar. Varje anrop måste tillåtas både av rollen och av nyckelns omfattning. Använd nycklar i kod som körs på servern.
Skapa en integration och nyckel#
Skapa integrationen
Öppna Admin → Integrations och ange namn, beskrivning och roll. Standardrollen är Viewer. Du kan bara välja roller inom dina egna behörigheter; integrationer kan inte administrera organisationen.
Skapa nyckeln
Välj New key, namn, omfattning och ett eventuellt slutdatum. Kopiera nyckeln
orbk_live_…direkt. Den visas bara en gång och kan inte återställas.Skicka med nyckeln
Lägg till
Authorization: Bearer orbk_live_…i varje anrop. Lägg aldrig nyckeln i en URL eller i versionshanterad kod. Prova gärna det första anropet.
| Omfattning | Tillåter |
|---|---|
read | GET-anrop för samlingar, objekt, tiles, innehåll, kartor, jobb och listor över webhooks. |
read_write | GET-anrop och de skrivanrop som rollen tillåter, bland annat uppladdning, export och hantering av webhooks. |
En read_write-nyckel med rollen Viewer får inte redigera objekt. En read-nyckel med rollen Editor får inte skriva, men kan fortfarande lämna ut all data som rollen får läsa. Båda behöver därför hållas hemliga.
Viewer-integrationer är gratis. En integration med en roll utöver Viewer räknas som en skaparplats. Gränserna är 5 aktiva nycklar per integration och 50 integrationer per organisation.
Byt nyckel eller stoppa åtkomst#
- Byt nyckel: skapa en ny, uppdatera ditt system och återkalla sedan den gamla. En återkallelse är permanent.
- Inaktivera: stoppa integrationens nycklar och webhooks tillfälligt. Aktivera den igen för att återuppta dem. Radera: ta bort integrationen tillsammans med dess nycklar och webhooks.
- Fördröjning: cache för nycklar och tiles kan göra att återkallad åtkomst fungerar i några minuter, som mest sex. En utgången eller återkallad nyckel ger
401när cachen löpt ut.
Webbläsare och anonym åtkomst#
En nyckel som skickas med en Origin-header nekas med 403 key_in_browser, både av API:et och tile-servern. På publika webbplatser använder du anonym åtkomst till publicerade lager.
Utan inloggningsuppgifter kan ett anrop läsa innehåll som exponeras av publicerade dashboards, Journeys och kartor. Innehåll som inte är tillgängligt ger 404. Anonym åtkomst har en lägre anropsgräns.
Användartoken#
Du kan också skicka en användares OrbGIS-åtkomsttoken som bearer-token. Den följer personens behörigheter, har en giltighetstid och måste förnyas. Använd en integrationsnyckel för jobb som ska köras utan att någon är inloggad.