Hopp til innhold
skribbskribb

Utviklere

Filer

Plattform

Her laster du opp bilder og nedlastingsfiler. Opplastingsruta tar multipart/form-data i stedet for JSON, fordi bodyen er en fil. Har du bildet liggende på en adresse i stedet for på disk, henter from-url det for deg, og den ruta er vanlig JSON.

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.

POST/v1/media

media:write

Last opp et bilde eller en nedlastingsfil

purpose=image legger filen i det åpne mediebiblioteket og svarer med en url du kan legge inn i images på et produkt. purpose=post legger den i publikasjonens eget mediebibliotek og svarer med en id du kan sette som featured_image.id på et innlegg. De to er ikke samme sted, og det er derfor det er to: et innlegg viser til forsidebildet sitt med en id fra sitt eget bibliotek, så en url herfra er ikke noe featured_image kan holde. purpose=delivery legger filen i den private butikkbøtta og svarer med en key du kan sette som delivery_file_key, og med vilje uten url: filen er det kjøperen betaler for, og den serveres bare gjennom nedlastingsruta etter et betalt kjøp.

Bodyen du sender

Sendes som multipart/form-data, ikke som JSON.

purposestringpåkrevd
image for et produktbilde, post for et forsidebilde til et innlegg, delivery for en fil kjøperen laster ned.
filebinarypåkrevd
Selve filen. Bilder kan være inntil 5 MB, og må være PNG, JPG, WebP, SVG eller GIF.

Svaret · 201

mediaMedia
Filen slik den ble lagret.
Svar
{
  "media": {
    "url": "https://media.skribb.no/…/krus.jpg",
    "key": "…/krus.jpg",
    "purpose": "image"
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/media" \
  -X POST \
  -F purpose=post \
  -F file=@bilde.png

POST/v1/media/from-url

media:write

Hent et bilde fra en adresse

Ligger bildet allerede på en adresse, henter vi det og legger det der du sier, så du slipper å laste det ned selv for å laste det opp igjen. Svaret er det samme som fra opplastingsruta, pluss source. purpose er post eller image, ikke delivery: å hente en adresse inn i den private butikkbøtta er noe annet enn å gi et innlegg et forsidebilde. Vi henter bare over https, følger inntil tre videresendinger og sjekker hver eneste adresse på veien, tar bare PNG, JPG, WebP og GIF, og aldri SVG, som er et dokument som kan kjøre kode. Det er innholdstypen som avgjør, ikke hva adressen slutter på, og vi leser aldri mer enn 5 MB. Adresser som peker inn i vårt eget eller ditt eget nett, blir avvist.

Idempotency-Key:
Sender du den, henter vi bildet én gang selv om kallet kommer to ganger. Svaret på det andre kallet er det samme som på det første.

Bodyen du sender

urlstringpåkrevd
https-adressen bildet ligger på.
purposestring
post for et forsidebilde til et innlegg, image for et produktbilde. Standard er post.

Svaret · 201

mediaMedia
Bildet slik det ble lagret.
Svar
{
  "media": {
    "id": "med_9f2…",
    "url": "https://bitvis.skribb.no/media/bankid.jpg",
    "purpose": "post",
    "source": "https://cdn.example.com/bilder/bankid.jpg"
  }
}
# Kaller skribb-klienten: https://skribb.no/utviklere/autentisering#klient
skribb "/media/from-url" \
  -X POST \
  -H "content-type: application/json" \
  -d '{
    "url": "https://example.no/side"
  }'

Objekter

Media

En opplastet fil.

Felter

idstringikke alltid med
Bare for purpose=post. Den du setter som featured_image.id på et innlegg. Et bilde lastet opp som image har ingen id, fordi det ligger et annet sted enn innleggene.
urlstringikke alltid med
Den offentlige adressen. For image og post. Utelatt for delivery, fordi en fil kjøperen betaler for ikke skal ha en adresse som virker uten et kjøp.
keystringikke alltid med
Nøkkelen filen ligger under. Den du setter som delivery_file_key. For image og delivery.
purposestring
image, delivery eller post, som du sendte inn.
sourcestringikke alltid med
Bare fra from-url: adressen bildet faktisk ble hentet fra. Den er ikke alltid den du sendte, for en adresse kan sende oss videre, og da er det denne som sier hvor bildet ligger.

← Alle rutene