Hopp til innhold
skribbskribb

Utviklere

API-referanse

Har du et lager, en kasse eller noe du har skrevet selv, kan du koble det til skribb i stedet for å taste det samme to steder. API-et gir deg produktene, lageret, bestillingene, innleggene, sidene og abonnentlista i publikasjonen din.

https://api.skribb.no/v1 · versjon v1

Alle sidene

Referanse

Kom i gang

  1. Godta Tillegg E

    Nøkkelen krever det. Systemet du kobler til er din mottaker, ikke en underdatabehandler for skribb. Les Tillegg E →

  2. Lag en nøkkel

    Du finner den under Innstillinger, fanen API. Huk av tilgangene den skal ha. Mangler én, svarer ruta 403 og sier hvilken. Nøkkelen vises én gang, så kopier den med det samme. Lag en nøkkel →

  3. Kall /me

    Ruta svarer på enhver gyldig nøkkel. Den sier hvilken publikasjon nøkkelen gjelder, og hvilke produkter publikasjonen har. 401 betyr feil eller tilbaketrukket nøkkel.

    Forespørsel
    curl "https://api.skribb.no/v1/me" \
  -H "Authorization: Bearer $SKRIBB_API_KEY"
    Svar
    {
  "publication": {
    "handle": "kari",
    "title": "Kari skriver",
    "kind": "site",
    "shop_enabled": true,
    "url": "https://kari.skribb.no"
  },
  "products": {
    "publikasjon": { "enabled": true, "plan": null },
    "nettsted": { "enabled": true, "plan": "komplett" },
    "nettbutikk": { "enabled": true, "plan": null }
  },
  "key": {
    "name": "Lagerstyring",
    "prefix": "skribb_sk_ab12cd34",
    "scopes": ["products:read", "products:write"]
  }
}

Hele API-et som OpenAPI: api.skribb.no/openapi.json. Den er bygd på samme oversikt som disse sidene, så en klientgenerator får både bodyen du sender og den du får tilbake.

Over hele API-et

  • Autentisering

    Nøkkelen sendes som bearer-token. Mister du den, trekker du den tilbake.

  • Tilganger

    Hva hver avhuking på nøkkelen gir. Lesing og skriving er alltid delt.

  • Konvensjoner

    Penger, tid, paginering og gjentatte forsøk.

  • Grenser

    Rundt 120 kall i minuttet per nøkkel, og noen ting API-et med vilje ikke gjør.

  • MCP-server

    Koble en assistent til publikasjonen. Adressen, tilgangen og verktøyene den får.

  • Webhooks

    Få beskjed når noe skjer, i stedet for å spørre oss på en timer.

  • Feil

    Alt er JSON, også feilene. Koden er den du bygger på.

  • Endringer

    Løftene om v1, med endringsloggen under.

Guider

Referanse, sortert etter produkt

Plattform

Nøkkelen din og filopplasting. Enhver publikasjon når disse rutene, uansett hvilke produkter den har.

  • Nøkkelen

    Hva nøkkelen er, hvilken publikasjon den når og hva den får lov til. Enhver gyldig nøkkel når denne ruta, også en som bare har én tilgang.

  • Filer

    Her laster du opp bilder og nedlastingsfiler. Opplastingsruta tar multipart/form-data i stedet for JSON, fordi bodyen er en fil. Har du bildet liggende på en adresse i stedet for på disk, henter from-url det for deg, og den ruta er vanlig JSON.

Publikasjon

Innlegg, notater, abonnentlista og lesertallene. Hver publikasjon har dette, også en som er satt opp som nettsted.

  • Publikasjonen

    Tittelen, undertittelen, «Om»-teksten i bunnen og om publikasjonen skal finnes i søk. Det du ellers ville endret under Innstillinger.

  • Domene

    Adressen publikasjonen svarer på, og hva som eventuelt står igjen før den virker. Ruta leser bare. Den kan verken kjøpe, flytte eller si opp et domene. Et .no-kjøp er en erklæring fra den som skal eie navnet, og det er ikke noe en integrasjon gjør på vegne av noen. Et domene kommer hit på én av to måter, og de svarer ulikt. Er det kjøpt gjennom skribb, ligger DNS-en hos oss, og da står dns null mens registration sier når det fornyes. Er det kjøpt et annet sted og koblet til, er det omvendt: dns viser postene du legger inn hos leverandøren din, og registration står null. Egen adresse følger med skribb Pro og begge nettsted-pakkene, men ruta svarer uansett: uten et eget domene får du domain null og skribb-adressen.

  • Utseende

    Tema, fargemodus, aksentfarge, skrifter og selve leseflaten, slik de står under Utseende i Innstillinger. Verdiene er faste nøkler fra palettene våre. Hver av dem er målt mot WCAG AA før den ble lagt til, og det er derfor ruta ikke tar imot en fargekode. Egne farger setter du under Finjustering, der vi kan måle dem mens du velger.

  • Innlegg

    Innleggene i publikasjonen din. Brødteksten er Portable Text, så content er alltid fasiten, men du kan skrive og lese Markdown i stedet.

  • Notater

    Korte notater: det som lander i notatstrømmen på tvers av publikasjoner. De deler tilgang med innlegg. Et notat er et kort innlegg og publiserer samme vei.

  • Abonnenter

    Lista over dem som får nyhetsbrevet. Den kan bare leses: påmelding er en samtykkehandling som skal gjennom den vanlige bekreftelsen. Hvert oppslag logges med nøkkelens id.

  • Innsikt

    Tallene bak Innsikt i oversikten. Fordi reads teller innloggede lesere, er dette atferdsdata om mennesker, og det ligger derfor bak analytics:read og ikke posts:read.

Nettsted

Sidene du bygger selv i nettstedbyggeren, og det besøkende skriver til deg gjennom kontaktskjema og chat. Krever en publikasjon satt opp som nettsted. Meldinger krever i tillegg et abonnement, Enkel eller Komplett.

  • Sider

    De frie sidene i nettstedbyggeren, altså ikke forsida, bloggen, butikken eller forhåndsvisningen, som skribb eier selv. Finnes bare på en publikasjon av typen nettsted; en blogg svarer 409 not-a-site-publication.

  • Meny

    Lenkene øverst på nettstedet, i den rekkefølgen de vises. Er menyen tom, viser nettstedet standardmenyen, og da svarer ruta med en tom liste. Det er plass til 12 lenker. Menyen finnes bare på en publikasjon av typen nettsted; en blogg svarer 409 not-a-site-publication.

  • Meldinger

    Det besøkende har skrevet til deg: innsendte kontaktskjemaer og chat-samtaler. Du kan lese dem, si fra at du har tatt hånd om en av dem, svare i chat og slette. Uten abonnement svarer rutene 409 komplett-plan-required i stedet for en tom liste. Chat finnes bare på Komplett, så på Enkel er chat-lista tom uten at noe er galt. Hvert oppslag og hver sletting logges med nøkkelens id, som på abonnentlista.

Nettbutikk

Varene, lageret, bestillingene og frakten. Ligger oppå det du ellers har, så både en blogg og et nettsted kan ha butikk. Krever at nettbutikken er slått på.

  • Produkter og lager

    Varene i nettbutikken. Uten en påslått butikk svarer rutene 409 shop-not-enabled.

  • Kategorier

    Registeret som gir kategori-sluggene på et produkt et navn. Uten en rad her har slugen ingenting å slå opp, og produktet viser seg ikke under noen kategori.

  • Kampanjer

    Rabattkodene og tilbudene i butikken. Én regel dekker alle formene: en kode kunden skriver inn, et tilbud som slår inn av seg selv, fri frakt over et beløp, en pris bare for abonnenter. Lesing og skriving er to ulike tilganger, fordi en rabattkode er penger.

  • Bestillinger

    Betalte kjøp. En bestilling bærer kjøperens e-post, og for fysiske varer navn og adresse, så orders:read gir mer personopplysninger enn noen annen tilgang. Som resten av nettbutikken krever rutene at butikken er slått på, ellers svarer de 409 shop-not-enabled.

  • Butikkinnstillinger

    Frakt og nedlastingsgrenser. Frakt har sin egen tilgang: en fraktrad er en pris kjøperen ender opp med å betale.