REST API

Bygg vidare på dina Skimle-projekt

En enda slutpunkt per riktning – läsa eller skriva – för varje projektresurs. Autentisera med en projektspecifik API-nyckel, skicka en JSON-åtgärd och få JSON tillbaka.

Kom igång i tre steg

Från noll till ditt första autentiserade anrop.

1

Skapa en API-nyckel

API-nycklar gäller för ett enskilt projekt och en enda åtkomstnivå (läsa eller redigera).

  1. 1. Öppna sidan med API-nycklar
  2. 2. Välj vilket projekt nyckeln ska gälla och om den ger läs- eller redigeringsåtkomst
  3. 3. Kopiera nyckeln – Skimle sparar bara dess hash

Kopiera nyckeln direkt.

Hela nyckelvärdet visas en enda gång, när nyckeln skapas. När du stängt dialogrutan finns bara hashen kvar hos oss – en förlorad nyckel måste utfärdas på nytt.

2

Skicka din första förfrågan

Skicka med nyckeln som Bearer-token och åtgärden i JSON-kroppen. Alla slutpunkter tar emot JSON och svarar med JSON.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

Läsnycklar slutar på r och kan bara anropa /api/skimle-read. Redigeringsnycklar slutar på e och kan anropa båda slutpunkterna.

3

Öppna API-referensen

Bläddra bland alla slutpunkter med beskrivningar, förfrågningsstrukturer och en panel för att testa direkt. Varje rutt tar emot en diskriminerad union med action som nyckel.

Den råa OpenAPI 3.1-specifikationen finns på /api/openapi.json.

Redo att börja bygga?

Hantera dina projektnycklar, eller titta på MCP-servern för agentiska klienter.