API-integraties – Toegang, Beleid & Privacy

Huidige versie: v3.6 (read-only)
v3.8 is in ontwikkeling (beta), alleen beschikbaar op verzoek en na beoordeling.

1. Toegang tot de API

  • API-toegang is beschikbaar voor restaurants zelf (eigen gebruik).
  • Toegang geldt uitsluitend voor uitlezen van data (read-only) voor dat specifieke restaurant.
  • Het uitlezen van meerdere restaurants tegelijk is op dit moment nog niet mogelijk.
  • Externe integratiepartners kunnen toegang krijgen, mits expliciete toestemming van het restaurant én binnen de scope van API v3.6.

Beschikbare omgevingen

  • Productieomgeving: live data, alleen uitlezen toegestaan.
  • Testomgeving (UAT): voor technische validatie en teststappen.
    ➤ Onze SwaggerHub API-documentatie is beschikbaar voor deze testomgeving.

2. Beschikbare API-endpoints

Hieronder een overzicht van de endpoints en de versies waarin ze beschikbaar zijn.

✅ = beschikbaar, ❌ = niet beschikbaar

Orders

Endpoint v3.6 v3.8 Toelichting
/orders/recent ✅ ✅ Recente bestellingen ophalen
/orders/recent/{platform} ✅ ✅ Gespecificeerd per platform
/orders/archived ✅ ✅ Archief ophalen
/orders/archived/{platform} ✅ ✅ Gespecificeerd per platform
/orders/unconfirmed ✅ ✅ Nog te bevestigen orders
/orders/unconfirmed/{platform} ✅ ✅ Gespecificeerd per platform
/orders/deleted ✅ ✅ Verwijderde orders
/orders/preordered ✅ ✅ Vooraf geplaatste orders
/orders/preordered/{platform} ✅ ✅ Gespecificeerd per platform
/order/{platform}/{id} (GET) ✅ ✅ Orderdetails
/order/create/{platform} (POST) ❌ ✅ Alleen in v3.8 (schrijven, beta)
Order inschieten
/order/{platform}/{id} (PUT) ❌ ✅ Alleen in v3.8 (schrijven, beta)
Orderstatus bijwerken

Accounting

Endpoint v3.6 v3.8 Toelichting
/accounting/turnover ✅ ✅ Omzet ophalen

Restaurant Info

Endpoint v3.6 v3.8 Toelichting
/restaurant ✅ ✅ Basisinformatie
/restaurant/menu ✅ ✅ Menukaart ophalen
/restaurant/discounts ✅ ✅ Kortingen ophalen
/restaurant/reviews ✅ ✅ Klantreviews ophalen

Restaurant Tables

Endpoint v3.6 v3.8 Toelichting
/restaurant/tables ✅ ✅ Overzicht tafels
/restaurant/table/{tableId} (GET) ✅ ✅ Detailinformatie tafel
/restaurant/table (POST) ✅ ✅ Nieuwe tafel toevoegen
/restaurant/table/{tableId} (PUT) ✅ ✅ Tafel aanpassen
/restaurant/table/{tableId} (DELETE) ✅ ✅ Tafel verwijderen

Lookup & POS

Endpoint v3.6 v3.8 Toelichting
/lookup/{zipcode}/{streetNumber} ✅ ✅ Adreslookup
/pos/client/info (POST) ✅ ✅ POS-informatie

3. Privacy & bescherming klantgegevens

  • uitsluitend gegevens die nodig zijn voor operationele verwerking van bestellingen.
  • Klantgegevens zoals e-mailadres, telefoonnummer of geboortedatum worden niet via de API gedeeld.
  • De API is nadrukkelijk niet bedoeld voor marketing, analyse of andere doeleinden.

Uitzondering: e-mailadressen in Mijn Sitedish

  • Restaurant-eigenaren kunnen via support verzoeken om e-mailadressen in te zien in het klantenbestand in Mijn Sitedish.
  • Alleen beschikbaar voor klanten die daadwerkelijk een bestelling hebben geplaatst.
  • Valt volledig binnen de kaders van de AVG (klant stemt in bij bestelling).

4. Voorwaarden & gebruikstypes

Gebruikstype Uitlezen (read-only) Orders inschieten (write) Voorwaarden
Eigen gebruik (restaurant) ✅ ❌ (alleen v3.8 beta op verzoek) Toegang via support
Integratiepartner (API-scope v3.6) ✅ ❌ Toestemming restaurant vereist
Integratiepartner (buiten scope) ❌ ❌ Verzoek + beoordeling door Sitedish
  • Voor externe partijen is een verwerkersovereenkomst verplicht bij klantdata.
  • Verzoeken buiten standaard scope worden individueel beoordeeld op noodzaak, privacy en haalbaarheid.

5. Aanvraagproces

We ontwikkelen een aanvraagformulier. Een aanvraag bevat minimaal:

  • API-versie (v3.6, v3.8 beta of afwijkend verzoek)
  • Naam aanvrager
  • Restaurantnaam
  • Gebruikstype (eigen restaurant / integratiepartner)
  • Toelichting/argumentatie
  • Gebruik testomgeving? (ja/nee)

💡 Tip: uitlezen via v3.6 kan vaak direct worden vrijgegeven.
Voor schrijven of beta (v3.8) geldt verplichte testvalidatie.