Hopp til innhold
skribbskribb

Utviklere

Sider

Nettsted

Sidene i nettstedbyggeren. De frie sidene har hver sin adresse, og forsida har slugen home. Bloggen, butikken og forhåndsvisningen eier skribb selv, og de får du ikke til herfra.

Krever en publikasjon satt opp som nettsted. Meldinger krever i tillegg en pakke, Skribb Litt eller Skribb Mer.

Alle sidene

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

GET/v1/pages

pages:read

Hent alle egne sider

Forsida er ikke med i lista. Den henter du med GET /v1/pages/home.

Svaret · 200

pagesPage[]
Alle frie sider, med blokker.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/pages"

GET/v1/pages/{slug}

pages:read

Hent én side

home gir forsida. Har nettstedet ingen forside ennå, svarer vi 404.

Svaret · 200

pagePage
Sida.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
page_slug="om-oss"

skribb "/pages/$page_slug"

PUT/v1/pages/{slug}

pages:write

Lag eller erstatt en side

Send hele sida. 201 når den er ny, 200 når du erstatter en som fantes. Blokker vi ikke kjenner igjen, blir forkastet i stedet for å velte hele lagringen, så les blocks i svaret om du er i tvil på hva som gikk inn. Unntaket er seo_description, og_image og parent: sender du dem ikke, står de som før. Med slug home skriver du forsida. Den teller ikke med i hvor mange sider nettstedet kan ha, og den hører ikke hjemme i menyen: forsida ligger alltid på /.

Bodyen du sender

titlestringpåkrevd
Tittelen. Inntil 200 tegn.
blocksobject[]påkrevd
Blokkene, i rekkefølge. Tom liste er lov og gir en tom side. Blokker som ikke går an å lese, blir forkastet.
seo_descriptionstring | null
Beskrivelsen for søkemotorer og delinger, inntil 160 tegn. Linjeskift blir til mellomrom. Lengre enn det gir 422 bad-seo-description. null eller tom tekst henter den fra sida igjen. Uten feltet står den som før.
og_imagestring | null
Delingsbildet: en full http- eller https-adresse, eller en sti på nettstedet som /media/bilde.jpg. Noe annet gir 422 bad-og-image. null eller tom tekst henter bildet fra sida igjen. Uten feltet står det som før.
parentstring | null
Slugen til sida denne skal ligge under. Den må finnes, ellers svarer vi 422 no-such-parent. Sida selv og forsida gir 422 bad-parent. Ligger sida du peker på selv under en annen, eller har denne sida sider under seg, svarer vi 422 parent-too-deep: det er bare ett nivå. null eller tom tekst legger sida øverst. Uten feltet står den som før. Lag sida over først.

Svaret · 200

pagePage
Sida slik den ble lagret.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
page_slug="om-oss"

skribb "/pages/$page_slug" \
  -X PUT \
  -H "content-type: application/json" \
  -d '{
    "title": "Sommerbrev",
    "blocks": [
      {
        "_type": "block",
        "style": "normal",
        "children": [
          {
            "_type": "span",
            "text": "Det ble en lang måned."
          }
        ]
      }
    ]
  }'

DELETE/v1/pages/{slug}

pages:write

Slett en side

Sida slettes for godt, til forskjell fra et produkt, som blir stående skjult. Peker menyen på sida, svarer vi 409 page-in-menu i stedet, og menu i svaret sier hvilke lenker det gjelder. Ta dem ut med PUT /v1/menu først. Ligger andre sider under den, svarer vi 409 page-has-children, og children i svaret lister dem. Flytt dem med PUT og parent først. Forsida kan ikke slettes, og home gir 409 cannot-delete-home.

Svaret · 200

deletedstring
Slugen til sida som ble slettet.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
page_slug="om-oss"

skribb "/pages/$page_slug" \
  -X DELETE

Objekter

Page

En side i nettstedbyggeren, fri eller forsida.

Felter

slugstring
Adressen sida ligger på. home er forsida, som ligger på /.
titlestring
Tittelen. Inntil 200 tegn.
blocksobject[]
Blokkene sida er satt sammen av, i rekkefølge. Hver blokk har en type og feltene den typen bruker. Blokker vi ikke kjenner igjen, er ikke med: de ble forkastet da sida ble lagret.
seo_descriptionstring
Beskrivelsen søkemotorer og delinger viser, inntil 160 tegn. Tom betyr at vi henter den fra sida selv: undertittelen i toppseksjonen, ellers første avsnitt.
og_imagestring
Bildet som vises når sida deles. Tom betyr at vi bruker det første bildet på sida.
parentstring | null
Slugen til sida denne ligger under, eller null når den ligger øverst. Da viser sida en sti over tittelen: Forside, sida over og denne sida. Adressen endrer seg ikke, /bad blir ikke /tjenester/bad. Bare ett nivå: sida over ligger selv øverst.

← Alle rutene