API-nycklar

Membra använder sig av ett REST-baserat API där alla utdata är JSON.

Membras alla APIer kräver en giltig API-nyckel för att man skall kunna använda dem. API-nycklarna skapas i Membra av föreningens administratör genom att generera en API-nyckel samt registrera infomation om vad den skall användas till.

Teknisk dokumentation till API:et (på engelska) finns på:
Version 1: api.membra.fi
Version 2: dev.membra.fi

Vad är en API-nyckel?

En API-nyckel är en unik sträng som skickas med varje API-anrop för att identifiera vem det är som använder APIet. En API-nyckel är privat och skall inte delas med andra, annars riskerar man att någon annan använder API-nyckeln i sitt namn.

Underhåll av API-nycklar

Vyn API-nycklar finns i undermenyn Inställningar. Här underhålls API-nycklarna sker i Membra och man måste vara administratör för att ha tillgång till funktionen.

Vyn API-nycklar

Skapa en API-nyckel

Skapa API-nyckel

För att skapa en API-nyckel behöver man ge den ett namn, som vanligtvis är namnet på den applikation som skall skapas med API-nyckeln. Det går också att välja om API-nyckeln ska vara aktiv eller stoppad. En stoppad nyckel kommer inte att fungera, så länge som dens status är stoppad.

Själva API-nyckeln får man kopierat genom att trycka på Visa i övre fliken.

Ändra uppgifter om en API-nyckel

Det går att ändra namn, beskrivning och status på API-nyckeln.

Om man märker att en API-nyckel missbrukas eller av någon annan orsak inte skall användas kan man ändra status till stoppad. En stoppad API-nyckel fungerar inte och Membra returnerar ett felmeddelande vid användning.

Ta bort API-nyckel

Genom att ta bort en API-nyckel slutar omgående allt som använder API-nyckeln att fungera. Denna åtgärd kan inte ångras.

Om man tar bort en API-nyckel i misstag måste den registreras på nytt för hand med exakt samma API-nyckel, annars måste den applikation som använder API-nyckeln uppdateras med en ny.

Feedback