Utviklere
Oversikt
https://api.skribb.no/v1 · versjon v1
Alle sidene
Kom i gang
Guider
Referanse
Nyhetsbrev
Kom i gang
Godta Tillegg E
Lag en nøkkel
Nøkkelen vises én gang. Lag en nøkkel →
Kall /me
Forespørsel curl "https://api.skribb.no/v1/me" \ -H "Authorization: Bearer $SKRIBB_API_KEY"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"] } }
Hele API-et som OpenAPI: api.skribb.no/openapi.json.
Over hele API-et
- Autentisering
Nøkkelen sendes som bearer-token. Mister du den, trekker du den tilbake.
- Tilganger
Hva hver avhuking på nøkkelen gir. Lesing og skriving er alltid delt.
- Konvensjoner
Penger, tid, paginering og gjentatte forsøk.
- Grenser
Rundt 120 kall i minuttet per nøkkel, og noen ting API-et med vilje ikke gjør.
- MCP-server
Koble en assistent til publikasjonen. Adressen, tilgangen og verktøyene den får.
- Webhooks
Få beskjed når noe skjer, i stedet for å spørre oss på en timer.
- Feil
Alt er JSON, også feilene. Koden er den du bygger på.
- Endringer
Løftene om v1, med endringsloggen under.
Guider
- Hold lageret i sync
Et annet system eier beholdningen, og skribb følger etter.
- Fra bestilling til pakke på vei
Ta imot en betalt bestilling, send den videre til fraktsystemet og gi kjøperen et sporingsnummer.
- Publiser fra din egen editor
Skriv i Markdown der du vil, og publiser innlegget herfra.
- Send et nyhetsbrev fra ditt eget system
Fra nøkkel til levert e-post: sett utseendet, få folk på lista, skriv brevet og hør hva som skjedde med det.
Referanse, sortert etter produkt
Plattform
Nøkkelen din og filopplasting.
- Nøkkelen
Hva nøkkelen er, hvilken publikasjon den når og hva den får lov til.
- Filer
Bilder og nedlastingsfiler.
- Enheter
Telefonene skribb-appen har meldt på for varsler. Bare skribb-appen kan bruke disse rutene: skribb sender ikke varsler inn i andres apper, så en annen nøkkel eller et annet program får 403 skribb-app-only. Vil du vite når noe skjer, bruk webhooks. En telefon hører til godkjenningen den ble meldt på med, og forsvinner når den godkjenningen kobles fra. Push-tokenet kommer aldri tilbake i et svar.
- Varsler i oversikten
Lar skribb-appen merke varslene i oversikten som lest, slik at det du har sett på telefonen, ikke lyser i bjella på skribb.no. Bare skribb-appen kan bruke ruta: en annen nøkkel eller et annet program får 403 skribb-app-only. Varslene merkes etter type, på samme måte som oversikten gjør når du åpner meldingene eller avtalene.
- Nyheter fra appen
Lar skribb-appen publisere en nyhet med bilde, tittel og noen linjer rett til Nyheter, og til abonnentene om eieren vil. Det følger med Skribb Mer. Bare skribb-appen kan bruke ruta: en annen nøkkel eller et annet program får 403 skribb-app-only. Vil du publisere fra et eget program, gjør POST /v1/posts den samme jobben, i alle pakker.
Publikasjon
Innlegg, notater og lesertallene.
- Publikasjonen
Tittelen, undertittelen, «Om»-teksten i bunnen og om publikasjonen skal finnes i søk. Det du ellers ville endret under Innstillinger.
- Domene
Adressen publikasjonen svarer på, og hva som eventuelt står igjen før den virker. Ruta leser bare: den kan verken kjøpe, flytte eller si opp et domene.
- Utseende
Tema, fargemodus, aksentfarge, skrifter og selve leseflaten, slik de står under Utseende i Innstillinger. Verdiene er faste nøkler fra palettene våre. Ruta tar ikke imot fargekoder. Egne farger setter du under Finjustering.
- Innlegg
Innleggene i publikasjonen din. Brødteksten er Portable Text, så content er alltid fasiten, men du kan skrive og lese Markdown i stedet.
- Notater
Korte notater: det som lander i notatstrømmen på tvers av publikasjoner.
- Innsikt
Tallene bak Statistikk og Besøk i oversikten.
Nettsted
Sidene du bygger selv i nettstedbyggeren, det besøkende skriver til deg gjennom kontaktskjema og chat, og avtalene de ber om. Krever en publikasjon satt opp som nettsted. Meldinger krever i tillegg en pakke, Skribb Litt eller Skribb Mer.
- Sider
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.
- Meny
Lenkene øverst på nettstedet, i den rekkefølgen de vises. Er menyen tom, viser nettstedet standardmenyen, og da svarer ruta med en tom liste. Det er plass til 12 lenker, og hver av dem kan samle inntil 10 lenker under seg.
- Design
Bredden, avstanden, titlene, fargene, seksjonene og formen på nettstedet, slik de står under Utseende i byggeren. Bredde og avstand kan alle endre. Resten følger med en pakke. Tema, aksentfarge og skrifter gjelder hele publikasjonen og står under Utseende.
- Bedriftsprofil
Adressen, telefonnummeret, e-posten, åpningstidene og området bedriften dekker. Det samme du fyller ut under Innstillinger → Nettsted, og det som står i bunnen av sidene.
- Lenker i bunnen
Kolonnene med lenker i bunnen av hver side, over kontaktlinja. Har nettstedet ingen, viser bunnen standardkolonnen Navigasjon. Det er plass til 3 kolonner med inntil 6 lenker i hver.
- Videresendinger
Gamle adresser som skal sende den besøkende videre med 301, for eksempel etter en flytting fra et annet nettsted. En videresending gjelder bare en adresse nettstedet ellers ville svart 404 på, så den skygger aldri for en side som finnes. Det er plass til 200.
- Meldinger
Det besøkende har skrevet til deg: innsendte kontaktskjemaer og chat-samtaler. Chat er et tillegg, så uten det er chat-lista tom uten at noe er galt. Hvert oppslag og hver sletting logges med nøkkelens id.
- Avtaler
Forespørslene besøkende sender gjennom avtaleskjemaet på nettstedet, svarene dine på dem, og tidene du åpner for booking. En besøkende kan bare velge en tid du har åpnet. Nye forespørsler kommer bare inn mens publikasjonen har tillegget Avtaler, men de som alt ligger her, kan du lese og svare på uansett. Hvert oppslag og hver sletting logges med nøkkelens id.
Nyhetsbrev
Lista, utsendelsene og utseendet på e-posten.
- Abonnenter
Lista over dem som får nyhetsbrevet. Ingen kan legges rett inn: påmelding går gjennom bekreftelsen uansett hvem som ber om den. Alt her logges med nøkkelens id.
- Nyhetsbrev
Utseendet og stemmen i e-posten abonnentene får, slik den står under Nyhetsbrev i oversikten. Aksentfargen og skriftene er felles og settes under Utseende.
- Utsendinger
En utsending er en e-post du skriver selv og sender til abonnentene, uten at det ligger et innlegg bak.
Nettbutikk
Varene, lageret, bestillingene og frakten. Krever at nettbutikken er slått på.
- Produkter og lager
Varene i nettbutikken.
- Kategorier
Registeret som gir kategori-sluggene på et produkt et navn. Uten en rad her har slugen ingenting å slå opp, og produktet viser seg ikke under noen kategori.
- Toppseksjoner
Teksten over produktene: én toppseksjon for hele butikken, og én for hver kategori. Den er bygd av de samme blokkene som en side. Har du ikke skrevet noen, er blocks tom, og butikken viser bare overskriften og produktene.
- Kampanjer
Rabattkodene og tilbudene i butikken. Én regel dekker alle formene: en kode kunden skriver inn, et tilbud som slår inn av seg selv, fri frakt over et beløp, en pris bare for abonnenter.
- Bestillinger
Betalte kjøp. En bestilling har kjøperens e-post, og for fysiske varer navn og adresse.
- Butikkinnstillinger
Frakt og nedlastingsgrenser.