Hopp til innhold
skribbskribb

Utviklere

Nøkkelen

Plattform

Hva nøkkelen er, hvilken publikasjon den når og hva den får lov til.

Alle sidene

Referanse

Kodeeksemplene kaller en skribb-funksjon. Hent klienten for språket ditt →

GET/v1/me

enhver nøkkel

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

products sier hvilke av de fem produktene publikasjonen faktisk har.

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": "mer" },
    "nettbutikk": { "enabled": true, "plan": null },
    "domene": { "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
site når publikasjonen har sider i nettstedbyggeren, ellers blog. Det samme som products.nettsted.enabled.
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 fem produktene, hvert med sin egen tilstand.

Felter

publikasjonProductLine
Innlegg, notater og innsikt. Alltid på. Pakken er litt, mer eller null.
nettstedProductLine
Sider, og med en pakke også meldinger (chat er et tillegg). På når publikasjonen har sider i nettstedbyggeren.
nyhetsbrevProductLine
Abonnentlista, utsendelsene og utseendet på e-posten. Alltid på, som publikasjonen: enhver publikasjon har en liste den kan sende til. Pakken er litt, mer eller null, den samme som publikasjonen har.
nettbutikkProductLine
Produkter, kategorier, bestillinger og butikkinnstillinger. Følger shop_enabled.
domeneProductLine
Om kontoen har et domene hos skribb. Domenet hører til kontoen, ikke til én publikasjon, så to publikasjoner under samme skaper svarer likt. Det sier ikke at denne publikasjonen svarer på domenet. Ingen ruter hører til dette produktet ennå.

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: litt eller mer. null betyr gratisnivået, som er en ekte tilstand og ikke en manglende verdi. Nettbutikken og domenet har ingen pakker, så de 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.
scopesstring[]
Tilgangene den har.

← Alle rutene