Hopp til innhold
skribbskribb

Utviklere

Nøkkelen

Plattform

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.

Alle sidene

Referanse

Kodeeksemplene kaller en skribb-funksjon du setter opp selv. Hent klienten for språket ditt og lim den inn én gang, så kan eksemplene under limes rett etter.

GET/v1/me

enhver nøkkel

Hvilken publikasjon nøkkelen gjelder, og hva den får lov til

Bruk den til å bekrefte at oppsettet er riktig før du bygger videre. products sier hvilke av de tre produktene publikasjonen faktisk har, så du slipper å kalle en rute for å finne ut at den svarer 409. Nøkkelen vises med navnet du ga den og de første tegnene, aldri i sin helhet.

Svaret · 200

publicationPublication
Publikasjonen nøkkelen når.
productsProductLines
Hvilke produkter publikasjonen har, og hvilken pakke de går på.
keyKey
Nøkkelen selv.
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"]
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/me"

Objekter

Publication

Publikasjonen nøkkelen gjelder for.

Felter

handlestring
Kortnavnet i adressen, uten .skribb.no.
titlestring
Tittelen leserne ser.
kindstring
blog eller site. Sidene i nettstedbyggeren finnes bare på site.
shop_enabledboolean
Om nettbutikken er slått på. Er den ikke det, svarer butikkrutene 409.
urlstring
skribb-adressen. Et eget domene, om publikasjonen har ett, viser det samme, men denne peker alltid riktig.

ProductLines

De tre produktene, hver med sin egen tilstand.

Felter

publikasjonProductLine
Innlegg, notater, abonnenter og innsikt. Alltid på. Pakken er pro eller null.
nettstedProductLine
Sider, og med et abonnement også meldinger (chat bare på Komplett). På når publikasjonen har kind site.
nettbutikkProductLine
Produkter, kategorier, bestillinger og butikkinnstillinger. Følger shop_enabled.

ProductLine

Ett av produktene, slik det står for denne publikasjonen.

Felter

enabledboolean
Om publikasjonen har produktet i det hele tatt. Er den ikke det, svarer rutene som hører til produktet 409 og sier hvilket.
planstring | null
Pakken, med navnet du ser på fakturaen: pro, enkel eller komplett. null betyr gratisnivået, som er en ekte tilstand og ikke en manglende verdi. Nettbutikken har ingen pakker, så den står alltid null.

Key

Nøkkelen du kalte med.

Felter

namestring
Navnet du ga den da du lagde den.
prefixstring
De første tegnene. Nok til å kjenne den igjen, ikke nok til å bruke den.
scopesstring[]
Tilgangene den har.

← Alle rutene