Swagger / OpenAPI Reference
Kaikki Sarka External API v1 -endpointit, parametrit, request bodyt, response-skeemat ja curl-esimerkit. Autentikointi tapahtuu headerilla X-API-Key. Tenant-avain näkee koko tenantin; asiakasavain rajataan täsmälliseen customerName-scopeen.
Base URL
https://api.sarkahq.com/api/external/v1Auth
X-API-Key: <key>AikarajausUTC RFC3339 tai
YYYY-MM-DD. Sessiohaut käyttävät overlap-semanttiikkaa.ExportitCSV/XLSX on paginoitu. Tarkista
X-Export-Truncated ja X-Next-Offset.Ensimmäinen kutsu
GET /me on kutsu suhteessa base URLiin, eli täydellinen polku on /api/external/v1/me. Se kertoo onko avain voimassa, mihin tenanttiin se kuuluu ja onko se customerName-rajattu.
Asiakasavaimet
customerName-scope vertaa nimeä täsmällisesti asseteihin ja palvelupyyntöihin. Pidä nimi yhtenäisenä integraatioissa.
Nopea testikutsu
Kopioi avain tenant-asetuksista ja testaa scope:
export SARKA_BASE_URL="https://api.sarkahq.com/api/external/v1"
export SARKA_API_KEY="sk_sarka_..."
curl -sS "$SARKA_BASE_URL/me" \
-H "X-API-Key: $SARKA_API_KEY" | jq .Endpointit
Skeemat
Alla näkyvät OpenAPI-komponentit, joista client-generatorit muodostavat tyyppimallit.