Hopp til innhold
skribbskribb

Utviklere

Sider

Nettsted

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.

Krever en publikasjon satt opp som nettsted. Meldinger krever i tillegg et abonnement, Enkel eller Komplett.

Alle sidene

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/pages

pages:read

Hent alle egne sider

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

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

PUT og ikke PATCH: en side er blokklista si, og en delvis endring av en sortert liste betyr ingenting fornuftig. 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.

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.

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

En ekte sletting, i motsetning til produkter. En side har ingen historikk å bevare. Peker menyen på sida, svarer vi 409 page-in-menu i stedet, og menu i svaret sier hvilke lenker det gjelder: en meny som peker på en side som ikke finnes, er nettopp det PUT /v1/menu nekter å lage, og da kan ikke sletting lage det i stedet. Vi rydder den ikke for deg, for hva som skal stå i toppen av nettstedet, er ditt valg og ikke vårt.

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 fri side i nettstedbyggeren.

Felter

slugstring
Adressen sida 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.

← Alle rutene