Hopp til innhold
skribbskribb

Utviklere

Publikasjonen

Publikasjon

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

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

publication:read

Hent innstillingene for publikasjonen

Her står bare det du kan endre. Kortnavnet i adressen, hva slags publikasjon det er og hvilke produkter den har, får du fra /v1/me, og ingenting av det kan settes herfra.

Svaret · 200

settingsPublicationSettings
Innstillingene.
Svar
{
  "settings": {
    "title": "Kari skriver",
    "tagline": "Brev om hverdagen på Vestlandet",
    "footer_about": "Kari Nordmann skriver om folk og vær.",
    "search_visible": true
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/publication"

PATCH/v1/publication

publication:write

Endre en eller flere av dem

Felt du ikke sender, står som de er. Send minst ett, ellers svarer vi 422 empty-update. En verdi som er for lang, blir avvist med en kode som navngir feltet. Vi kutter den aldri for deg, for du ville ikke sett hva som forsvant. Endringen går ut til publikasjonen med det samme, og hvis vi ikke når fram akkurat da, står den lagret her og går ut ved neste lagring.

Bodyen du sender

titlestring
2 til 120 tegn. Vi trimmer mellomrom i endene.
taglinestring | null
Inntil 200 tegn. Send null eller tom streng for å fjerne undertittelen.
footer_aboutstring
Inntil 280 tegn. Tom streng fjerner den.
search_visibleboolean
true lar publikasjonen finnes i søk, false skjuler den.

Svaret · 200

settingsPublicationSettings
Innstillingene slik de nå er.
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/publication" \
  -X PATCH \
  -H "content-type: application/json" \
  -d '{
    "title": "Kari skriver",
    "tagline": "Brev om hverdagen på Vestlandet"
  }'

Objekter

PublicationSettings

Innstillingene for publikasjonen selv.

Felter

titlestring
Tittelen leserne ser, i toppen, i nyhetsbrevet og i RSS. 2 til 120 tegn.
taglinestring | null
Undertittelen. null betyr at publikasjonen ikke har noen.
footer_aboutstring
«Om»-teksten i bunnen av sidene. Den er også beskrivelsen av publikasjonen i søkeresultater og delinger. Tom streng betyr at undertittelen brukes i stedet.
search_visibleboolean
Om publikasjonen skal kunne finnes i søk. false ber søkemotorene holde seg unna: sidene får meta robots og X-Robots-Tag, robots.txt stenger alt og sitemapet blir tomt. Det er «Skjul for søkemotorer» i Innstillinger, med motsatt fortegn.

← Alle rutene