API-nycklar låter dig läsa dina övervakningsdata programmatiskt via Ravnsights läs-API, och skapas under Inställningar → API.
Skapa en API-nyckel
Gå till Inställningar → API, ange ett beskrivande namn för nyckeln och klicka på Skapa nyckel. Namnet hjälper dig att känna igen var nyckeln används.
- Själva nyckeln visas bara en gång, direkt efter att den skapats. Kopiera den och spara den på ett säkert ställe med en gång.
- Efteråt visas endast nyckelns prefix i listan, tillsammans med skapandedatum, när den senast användes och antal förfrågningar.
- Varje plan har ett tak för antal nycklar. När taket är nått måste du ta bort en befintlig nyckel innan du kan skapa en ny.
Håll nyckeln hemlig
En API-nyckel ger läsåtkomst till ditt kontos data. Behandla den som ett lösenord.
- Lägg aldrig nyckeln i publik kod, i klientkod i webbläsaren eller i versionshanterat arkiv.
- Använd nyckeln endast från servrar eller verktyg du själv kontrollerar.
- Misstänker du att en nyckel läckt, klicka på Återskapa för att göra den gamla ogiltig och få en ny, eller Ta bort nyckeln helt.
Använda nyckeln mot läs-API:t
Skicka nyckeln i X-API-Key-headern i varje förfrågan. Headern Authorization: Bearer DIN_NYCKEL fungerar också.
Ett enkelt exempel med curl:
curl -H "X-API-Key: DIN_NYCKEL" https://ravnsight.se/api/v1/monitoring/sites
I nyckellistan finns en status för varje nyckel: Aktiv, Utgången eller Inaktiv. Bara aktiva nycklar godkänns.
En Pro-funktion
Läs-API:t är en Pro-funktion (api.read). På Free-planen finns ingen API-åtkomst, och sidan Inställningar → API är då inte tillgänglig. Om en administratör har stängt av API:t helt visas i stället meddelandet att API:t inte är tillgängligt.
Endpoints och exempel
För en fullständig lista över tillgängliga endpoints med exempelsvar, se artikeln Läs-API — endpoints och exempel.