API & Webhook Gebruiksbepalings
Laas bygewerk: Januarie 2025 · Toothless Holdings (Pty) Ltd
1.1 Die Oppie Werf API en webhook-dienste is beskikbaar vir gemagtigde derde-party ontwikkelaars, geïntegreerde sakeplatforms, en goedgekeurde sakevennote. Toegang word verleen op 'n geval-tot-geval-basis na die sluiting van 'n skriftelike API-toegangsooreenkoms met Toothless Holdings (Pty) Ltd.
1.2 Om API-toegang aan te vra, stuur 'n skriftelike versoek aan api@oppie-werf.co.za met die volgende inligting:
- Beskrywing van die beoogde gebruik van die API.
- Besigheidsregistrasienommer en kontakbesonderhede.
- Tegniese kontakpersoon se naam en e-posadres.
- Geskatte API-oproepvolume per dag.
1.3 Toothless Holdings behou die reg voor om API-toegang te weier sonder opgaaf van redes. Die verlening van API-toegang skep geen eksklusiwiteitsreg of lang-termyn-verbintenis van Toothless Holdings se kant nie.
1.4 Hierdie bepalings is aanvullend tot die platform se Meesterbepalings en Privaatheidsbeleid, wat ook op API-gebruikers van toepassing is. In die geval van konflik tussen hierdie bepalings en die skriftelike API-toegangsooreenkoms, sal die ooreenkoms voorkeur geniet.
2.1 Die Oppie Werf API gebruik Laravel Sanctum Bearer Token-stawing. Alle API-versoeke moet 'n geldige Bearer-token in die Authorization-opskrif insluit:
Authorization: Bearer {jou_api_token}
2.2 API-tokens word uitgereik na goedkeuring van die toegangsooreenkoms en word aan die gemagtigde integrasie-rekening gekoppel. Tokens kan te eniger tyd deur Toothless Holdings herroep word.
2.3 Die volgende koers-beperkings (rate limits) is van toepassing op alle API-toegangsvlakke:
- Gratis vlak: 60 versoeke per minuut, 5 000 versoeke per dag. Geen SLA-waarborg nie.
- Standaard vlak: 300 versoeke per minuut, 50 000 versoeke per dag. 99% beskikbaarheids-teiken.
- Enterprise vlak: Pasgemaakte koerse soos ooreengekom in die skriftelike API-toegangsooreenkoms.
2.4 Wanneer koers-beperkings oorskry word, sal die API met 'n 429 Too Many Requests-antwoord reageer en 'n Retry-After-opskrif insluit. Die integrasie moet eksponensiële terugtrekking (exponential backoff) implementeer.
2.5 Toothless Holdings hou ouditlogs van alle API-versoeke, insluitend IP-adresse, eindpunte, en tydstempels. Hierdie logs kan gebruik word vir foutopsporing, fakturering (by betaalde vlakke), en die ondersoek van misbruik.
3.1 Die Oppie Werf API mag gebruik word vir die volgende doeleindes, onderhewig aan die goedkeuring wat in die skriftelike ooreenkoms uiteengesit is:
- Die sinchronisering van lysings en voorraad tussen die integrasie-platform en Oppie Werf.
- Die lees van openbare lysing-data vir die doel van prysvergelyking of markanalise binne die toegelate gebruiksgeval.
- Die ontvangs van transaksie-kennisgewings via webhook vir goedgekeurde bestellingsverwerkingstelsels.
- Die bestuur van die integrasie-gebruiker se eie rekeningdata (lysings, betalings, biedingsgeskiedenis).
- Die bou van gemagtigde mobieletoepassing-integrasies wat namens eindgebruikers optree met hul uitdruklike toestemming (OAuth-vloei).
3.2 Enige gebruik buite die goedgekeurde gevalle vereis 'n gewysigde ooreenkoms. Stuur 'n versoek aan api@oppie-werf.co.za vir wysigings.
4.1 Die volgende gebruike is uitdruklik verbode en sal lei tot onmiddellike herroeping van API-toegang, en moontlike regstappe:
- Scraping: Enige geoutomatiseerde aflaai van data uit die API of die webwerf-koppelvlak (HTML-scraping) buite die toegelate API-eindpunte is verbode.
- Omgekeerde ingenieurswese: Die poging om die API se interne werking, algoritmes of databasisstruktuur deur middel van reaksie-analise of ander tegnieke te rekonstrueer.
- Token-deling: Die deel van API-tokens met derde partye of die gebruik van 'n enkele token vir meer as een integrasie sonder uitdruklike skriftelike toestemming.
- Omseiling van koers-beperkings: Die gebruik van veelvuldige tokens, IP-rotasie, of enige ander metode om die koers-beperkings te omseil.
- Kwaadwillige inset: Die stuur van kwaadwillige inset (SQL-inspuiting, XSS-aanvalle, bufferoorvloei, ens.) na enige API-eindpunt.
- Databemisstoring: Die stoor van Oppie Werf-data buite jou eie goedgekeurde stelsels, of die verkoop of versprei van Oppie Werf-data aan derde partye sonder toestemming.
- Mededingende intelligensie-insameling: Die gebruik van die API vir die bou van mededingende produkte of die sistematiese insameling van prysintelligensie vir mededingende doeleindes.
4.2 By die ontdekking van 'n sekuriteitskwesbaarheid in die API, moet dit onmiddellik verantwoordelik gerapporteer word aan sekuriteit@oppie-werf.co.za. Toothless Holdings verbind homself daartoe om bona fide-sekuriteitnavorsers in goeie trou te behandel en nie regstappe te neem teen verantwoordelike openbaarmaking nie.
5.1 Webhooks is uitgaande HTTP POST-versoeke wat Oppie Werf na jou geregistreerde eindpunt stuur wanneer spesifieke gebeurtenisse plaasvind (bv. nuwe bod, transaksie-bevestiging, betaling-ontvangst). Webhook-eindpunte moet aan die volgende vereistes voldoen:
- Beskikbaarheid: Die eindpunt moet 99% of meer van die tyd bereikbaar wees.
- Reaksietyd: Die eindpunt moet binne 5 sekondes met 'n HTTP
2xx-statuskode reageer. Versoeke wat nie binne 5 sekondes 'n2xx-respons ontvang nie, word beskou as mislukte aflewer. - HTTPS: Alle webhook-eindpunte moet HTTPS gebruik met 'n geldige SSL-sertifikaat. HTTP-eindpunte sal nie aanvaar word nie.
- Handtekening-verifikasie: Elke webhook-versoek bevat 'n HMAC-SHA256-handtekening in die
X-OppieWerf-Signature-opskrif. Jou eindpunt moet hierdie handtekening verifieer voor verwerking.
5.2 By mislukking van 'n webhook-aflewering sal Oppie Werf eksponensiële terugtrekking gebruik om tot 5 keer te herbestel (oor 'n tydperk van 24 uur). Daarna word die gebeurtenis as nie-afgelewer gemerk en sal nie outomaties herbestel word nie.
5.3 Jou eindpunt moet idempotent wees — dit wil sê, die herhaalde verwerking van dieselfde webhook-gebeurtenis (by herhaaldelike aflewering) moet nie duplikaat-aksies tot gevolg hê nie. Gebruik die unieke event_id in die webhook-payload vir duplikaat-kontrole.
5.4 Toothless Holdings bied geen SLA-waarborg op webhook-aflewering op die gratis vlak nie. Gewaarborgde aflewering met 'n SLA is slegs beskikbaar op die Standaard- en Enterprise-vlakke.
6.1 Vrywaring: Toothless Holdings (Pty) Ltd gee geen waarborg oor die beskikbaarheid, akkuraatheid of voortgesette werking van die API of webhook-dienste nie, insluitend op die gratis vlak. Die API word verskaf "soos is" en "soos beskikbaar" sonder enige uitdruklike of geïmpliseerde waarborg.
6.2 Toothless Holdings aanvaar geen aanspreeklikheid vir:
- Verliese voortspruitend uit API-onderbreking, verandering van eindpunte, of wysigings in reaksie-formate.
- Data-verlies weens mislukking van webhook-aflewering.
- Enige indirekte, gevolglike of bykomende skade voortspruitend uit die gebruik van of vertroue op die API.
- Sekuriteitsbreuke wat veroorsaak word deur die integrasie-party se eie stelsels of nalatigheid.
6.3 Herroeping van toegang: Toothless Holdings behou die reg voor om API-toegang onmiddellik en sonder vooraf kennisgewing te herroep in die geval van:
- Enige oortreding van hierdie bepalings.
- Misbruik van die API, insluitend oorskryding van koers-beperkings op 'n herhaalde of opsetlike wyse.
- Gebruik van die API vir onwettige doeleindes.
- Die beëindiging of verval van die skriftelike API-toegangsooreenkoms.
- Die besluit van Toothless Holdings om die API-diens te staak of te wysig.
6.4 Kennisgewingtydperk: By planmatige beëindiging of wesenlike verandering van die API sal Toothless Holdings redelike poging aanwend om ten minste 30 dae vooraf kennisgeging te gee via die e-posadres wat met die API-rekening geassosieer is. In die geval van noodbeëindiging weens misbruik of sekuriteitsrisiko geld geen kennisgewingtydperk nie.
6.5 By beëindiging moet die integrasie-party alle gestoorde Oppie Werf-data wat ingevolge die toegangsooreenkoms beperk is tot platformgebruik, binne 14 dae uitvee en dit skriftelik bevestig aan api@oppie-werf.co.za.
6.6 Hierdie bepalings word geïnterpreteer ingevolge die reg van die Republiek van Suid-Afrika. Geskille voortvloeiend uit die gebruik van die API sal onderworpe wees aan die jurisdiksie van die Suid-Afrikaanse howe, met voorkeur vir arbitrasie ingevolge AFSA-reëls.