REST API

Rakenna Skimle-projektien päälle

Yksi päätepiste suuntaa kohden — luku tai kirjoitus — kaikille projektin resursseille. Tunnistaudu projektikohtaisella API-avaimella, lähetä JSON-toiminto, saat JSON-vastauksen.

Aloita kolmessa vaiheessa

Nollasta ensimmäiseen tunnistettuun kutsuun.

1

Luo API-avain

API-avaimet ovat sidottuja yhteen projektiin ja yhteen käyttöoikeustasoon (luku tai muokkaus).

  1. 1. Avaa API-avaimet -sivu
  2. 2. Valitse projekti ja luku- tai muokkausoikeus
  3. 3. Kopioi avain — Skimle tallentaa siitä vain tiivisteen

Kopioi avain heti.

Koko avain näkyy vain kerran luonnin yhteydessä. Kun suljet ikkunan, palvelin säilyttää vain tiivisteen — kadonnut avain täytyy luoda uudelleen.

2

Lähetä ensimmäinen kutsu

Anna avain Bearer-tokenina ja toiminto JSON-rungossa. Kaikki päätepisteet ottavat ja palauttavat JSONia.

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

Lukuavaimet päättyvät kirjaimeen r ja toimivat vain /api/skimle-read -päätepisteessä. Muokkausavaimet päättyvät kirjaimeen e ja toimivat kummassakin.

3

Avaa API-referenssi

Selaa kaikkia päätepisteitä kuvauksineen, pyyntörakenteineen ja kokeile-paneelilla. Kumpikin reitti hyväksyy diskriminoidun union-rungon action-kentän mukaan.

Raaka OpenAPI 3.1 -määritys löytyy osoitteesta /api/openapi.json.

Valmis rakentamaan?

Hallitse projektin avaimia tai tutustu MCP-palvelimeen agenttiklienteille.