Shoporama-apper
Nedenfor finner du informasjon om hvordan du utvikler Shoporama-apper
Meny
1 På et øyeblikk
Alt i alt gir en Shoporama-app tilgang til to ting når en bruker installerer den i butikken sin:
REST-interfacet
at indsætte kode på udvalgte sider
Hvem som helst kan lage apper, men for at andre butikker skal kunne bruke appene dine, må du godkjennes.
2 Innstillinger og preferanser
Innstillingsalternativene for apper er
| Felt | Innhold |
|---|---|
| Navn | Kort navn. Brukes i oversikter og e-poster. |
| Beskrivelse | Lengre beskrivelse av hva appen din gjør. Det er ikke mulig å bruke HTML-koder. Bare a-tagger for lenker. |
| Kategori | Valgfri kategori |
| Tilgang til | Siden appen din oppretter et api-token i butikken som installerer appen, kan du velge om du vil ha skrive-, lese- eller alle rettigheter til dette api-tokenet. |
| Pris per måned | En månedlig pris som appen din koster. Det foretas en 80/20-deling, der Shoporama beholder 20 % og betaler ut resten. Når en app er byttet til aktiv, kan du ikke lenger øke prisen. Bare ned. |
| URL for tilbakekalling |
Én URL som kan motta alle tilbakekallinger og hendelser. Argumentet
Hvis appen din bruker felt der brukeren kan skrive inn informasjon, vil dette bli inkludert i For hendelser og webhooks vil anropet inneholde dataene som finnes i hendelsene og webhooksene våre. Det varierer om det er hendelser eller produkter, bestillinger osv. For å validere om en tilbakekalling kommer fra Shoporama, legger vi til overskriften |
| Kun tillatt i følgende butikker | Mulighet for å bare tillate appen på en rekke nettbutikker. |
| Webhooks | Her velger du hvilke webhooks du ønsker å motta. Du kan motta webhooks når det gjøres endringer i bestillinger (status, betalt, opprettet), produkter eller lager. |
| Hendelser |
Her velger du hvilke hendelser du ønsker å motta. Hendelser kan sendes oftere enn webhooks, for eksempel når en bruker legger noe i handlekurven eller går til kassen. Vi har følgende hendelser: add_to_basket
update_basket
view_basket
view_address
view_shipping
view_approve
view_thanks
approved
order_created
paid
add_label
remove_label
|
3 REST-tilgang
Når en app installeres i en butikk, opprettes det en api-nøkkel for appen, og med denne nøkkelen får du tilgang tilrest-grensesnittet vårt for den aktuelle butikken. Api-nøkler sendes til tilbakekallingsadressen din som feltetapp_token. Merk at de samme reglene gjelder for api-tilgang som for vanlige api-nøkler når det gjelder bruk.
I tillegg til å få tilgang til vårt vanlige rest-grensesnitt, er det mulig å hente ut en liste over nettbutikker som har installert appen din ved å ringe:
GET /REST/app-status HTTP/2
Host: www.shoporama.dk
Authorization: App {din token}
Merk at auth-scheme er App.
4 Sett inn kode
Det er mulig å sette inn kode på fire steder i butikkene som installerer appen:
<head>
<body>
</head>
</body>
Det er mulig å sette inn kode på alle sider, eller bare på produkter, destinasjonssider, kategorier, statiske sider, blogginnlegg, eller på /search, /basket, /address, /shipping, /approve, /thanks, /order og /also.
Det er mulig å bruke Smarty-kode i koden som settes inn, og det er mulig å få tilgang til verdiene som brukeren har lagt inn i felt som <{$app_vars.var_name}>.
Ovennevnte kan kombineres på hvilken måte du vil, så det er mulig å sette inn et stykke kode i <head>på alle sider, men på /thanks vil du legge til noe ekstra.
5 Felt
Med Fields kan du opprette noen inndatafelt som brukerne skal fylle ut når de installerer appen. Du kan opprette så mange felt du vil. Verdiene inkluderes i tilbakekallinger når brukeren oppdaterer innstillingene.
Vi støtter følgende felttyper:
text
integer
boolean
list
color
richtext
code
Eksterne felt
Det er mulig å bruke eksterne verdier for både tekst- og listefelt.
Eksterne lister
For lister hentes verdiene fra https://example.com/callback?type=field&name={name} og skal returnere json i key:value-format:
{
"key1": "value1",
"key2": "value2"
}
Eksterne tekstfelt
For tekstfelt hentes verdien fra samme URL som for lister. Verdien vises som skrivebeskyttet for brukeren. Formatet kan enten være en enkel tekststreng eller JSON:
{
"value": "tekst værdi"
}
Eller bare returnere en enkel tekststreng direkte.