Wat Het eindpunt SD DailyOrderReport biedt een lijst met dagelijks verwerkte orders per winkel in een machineleesbaar JSON-formaat. Deze gegevens kunnen worden gebruikt voor verdere verwerking. Als een winkel bijvoorbeeld Nesto wil gebruiken voor zijn prognoses, kan het API endpoint dienovereenkomstig worden vrijgegeven. Waar Admin: Winkel > Systeem instellingen > API-rechten (alleen mogelijk met SuperAdmin-autorisatie).

SD DailyOrderReport instellen

Deze handleiding beschrijft hoe je het eindpunt DailyOrderReport instelt op een SIDES-instantie.

Let op: SuperAdmin rechten zijn vereist voor het instellen.

Opmerking: Het eindpunt is gebaseerd op de mandant. Op mandant-instanties (bijv. burgerme.simply...de) kan toegang tot individuele winkels alleen worden beperkt door alleen de uuid van de winkel(s) te delen. 

1. De API-rechten aanmaken

1. Ga naar Admin: Winkel > Systeem instellingen > API-rechten.

a. statisticdata.dailyOrderReport

b. statisticdata.dailyOrderReportPublic

a. Klik op "Nieuw API-recht aanmaken" (1).

b. Voer statisticdata.dailyOrderReport in bij "Naam van de API-rechten".

c. Klik op "Opslaan" (2).

d. Klik op "Opslaan" (3).

Herhaal a.-d. voor de rechterkant: statisticdata.dailyOrderReportPublic

Opmerking: De spelling van de rechten is belangrijk.

2. Klik op "Nieuwe gebruiker aanmaken".

a. Bij "Rechtenselectie":
Selecteer de client waaraan je de DailyOrderReport-Interface wilt toevoegen (1).

b. Bij "Naam van de API-gebruiker":
Voer een naam in voor de aan te maken API-gebruiker; Aanbeveling:
Volg de conventie van ServiceProvider_DailyOrderReport (bijv. NESTO_DailyOrderReport) (2).

c. Bij "Doel van de API-gebruiker": public invoeren (3).

d. Bij "Wachtwoord":
Voer een willekeurig wachtwoord in, je hoeft het niet te onthouden (4). 


e. Bij "API-rechten toewijzen": Activeer de rechten voor "statisticdata.dailyOrderReport" en "statisticdata.dailyOrderReportPublic" zoals te zien is in de afbeelding (5).

3. Klik op "Opslaan".

3. De interface activeren

1. Ga naar Admin: Winkel > Externe applicaties.

2. Klik op "Nieuwe API-sleutel voor externe applicatie".

a. Selecteer een item in de vervolgkeuzelijst "API-gebruiker" (1). In de lijst worden mogelijk regels zonder tekens weergegeven. Probeer de eerste invoer.

b. Voer een naam in bij "Omschrijving van het API-sleutel" (2), bij voorkeur dezelfde als bij "Naam van de API-gebruiker".

c. Klik op "Opslaan".

Als je de juiste vermeldingen hebt geselecteerd en de naamgeving hebt gevolgd, komen de vermeldingen onder "Naam" en "API-gebruiker" overeen.

4. Te delen gegevens

Noteer de volgende gegevens voor het verlenen van toegang tot de interface:

1. "API-Token": SDPAK... (vanaf stap 3 - Admin: Winkel > Externe applicaties).
2. Vanuit Admin: Winkel > Winkels > Bewerken > Stamgegevens > Unieke winkel-ID - noem het store_uuid bij het delen, of de store_id uit de URL.

De "Unieke winkel-ID" heeft de voorkeur, vooral voor Franchiseketens, om redenen van gegevensbeveiliging!

Opmerking: Nesto en worqroom hebben mogelijk een extra sleutel nodig: de x-api sleutel.

Deze sleutel moet worden aangevraagd bij SIDES (DevOps).