Slik bruker du Sharefox API
Introduksjon til Sharefox API
Sharefox API er en samling av offentlige og private endepunkter som lar deg gjenskape Sharefox-opplevelsen ved hjelp av ditt foretrukne programmeringsmiljø og rammeverk.
Merk: Sharefox API er for øyeblikket i betaversjon, så endepunktene og dokumentasjonen av disse kan bli endret i fremtiden.
API-dokumentasjon
Den fullstendige Sharefox API-dokumentasjonen genereres automatisk når vi lanserer en ny versjon, og du finner den her: https://api.mysharefox.com/docs
Autentisering
De fleste endepunktene er offentlige, men noen endepunkter krever en autentisert bruker. For å sende en autentisert forespørsel må du logge på som bruker, og legge inn et "Bearer"-token i "Authentication"-hodet for de påfølgende forespørslene.
Sluttpunkter for autentisering: https://api.mysharefox.com/docs#
Sluttpunktsautentisering av butikkbrukere
Enkelte endepunkter, som "/orders/cart" og lignende, må forespørres på vegne av en butikkbruker. En butikkbruker representerer en registrert kunde i butikken.
Logg inn som butikkbruker: https://api.mysharefox.com/docs#
Autentisering av administratorbrukerens endepunkt
En admin-bruker er en privilegert bruker som kan utføre operasjoner på tvers av alle brukere i en butikk. Disse endepunktene har prefikset "/admin" i endepunktsbanen.
Logg inn som administratorbruker: https://api.mysharefox.com/docs#
Merk: Vær oppmerksom på at tokenformatet og svarstrukturen fra "/login" og "/admin/login" er forskjellige. Tokenet fra "/login" er et JWT-token med kort levetid, mens tokenet fra "/admin/login" er et ugjennomsiktig token med lang levetid. Begge brukes imidlertid på samme måte, som et Bearer-token i "Authentication"-forespørselshodet.
Bruk av API i produksjon
Sharefox-abonnementet ditt kan allerede inkludere Sharefox API-bruk - vennligst kontakt Support for å bekrefte godkjenning og aktivering for bruk i produksjon.