REST API

Byg videre på dine Skimle-projekter

Ét enkelt endepunkt pr. retning – læsning eller skrivning – for hver projektressource. Godkend dig med en projektspecifik API-nøgle, send en handling som JSON, og få JSON tilbage.

Kom i gang i tre trin

Fra nul til dit første godkendte kald.

1

Opret en API-nøgle

API-nøgler gælder ét enkelt projekt og ét enkelt adgangsniveau (læsning eller redigering).

  1. 1. Åbn siden med API-nøgler
  2. 2. Vælg hvilket projekt nøglen skal give adgang til, og om adgangen er til læsning eller redigering
  3. 3. Kopiér nøglen – Skimle gemmer kun dens hash

Kopiér nøglen med det samme.

Hele nøgleværdien vises kun én gang, når nøglen oprettes. Når du har lukket dialogen, er kun hashen tilbage hos os – en mistet nøgle skal udstedes på ny.

2

Send din første forespørgsel

Send nøglen som Bearer-token og handlingen i JSON-kroppen. Alle endepunkter tager imod JSON og svarer 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æsenøgler ender på r og kan kun kalde /api/skimle-read. Redigeringsnøgler ender på e og kan kalde begge endepunkter.

3

Åbn API-referencen

Gennemse alle endepunkter med beskrivelser, forespørgslernes opbygning og et felt til at afprøve dem. Hver rute tager imod en krop som en diskrimineret union med action som nøgle.

Den rå OpenAPI 3.1-specifikation findes på /api/openapi.json.

Klar til at bygge?

Administrér dine projektnøgler, eller se MCP-serveren til agentiske klienter.