Nedenfor finner du informasjon om hvordan du utvikler Shoporama-apper
Alt i alt gir en Shoporama-app tilgang til to ting når en bruker installerer den i butikken sin:
Hvem som helst kan lage apper, men for at andre butikker skal kunne bruke appene dine, må du godkjennes.
Apper opprettes på denne siden.
Last ned e-conomic-appen vår for å se et eksempel på en app som bruker rest-grensesnittet vårt.
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
{
"webshop_id": 1,
"webshop_url": "https://www.example.com/",
"app_token": "dcbfe5ad9e8af3495ca4582e364c1bce",
"app_token_daily_limit": 10000,
"app_token_current_usage": 200,
"installed": 1692857535,
"fields": {
}
}
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 og remove_label. |
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.
Det er mulig å sette inn kode på fire steder i butikkene som installerer appen. Disse er etter <head>, etter <body>, før </head> og før</body> . De forutsetter imidlertid at disse html-elementene finnes i butikken som installerer den. Det er mulig å sette inn kode på alle sider, eller bare på produkter, landingssider, kategorier, statiske sider, blogginnlegg, eller på /search, /basket, /address, /shipping, /approve, /thanks, /order og /also.
Det er enkelt å bruke Smarty-kode i den innlimte koden , og det er mulig å få tilgang til verdiene brukeren har skrevet 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.
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: tekst, heltall, boolsk, liste,farge, richtext, kode.
For lister er det mulig å bruke eksterne lister. Det vil si at når brukeren ser admin, hentes verdiene frahttps://example.com/callback?type=field&name={navn}, og den siden skal returnere json i key:value-format. For eksempel
{
"key1": "value1",
"key2": "value2"
}