Koppelen met Smart Trade API

Smart Trade is voorzien van een HTTP REST JSON API. Dit is een moderne mogelijkheid om koppelingen te bouwen. Ook beschikt de software over mogelijkheden om webhooks te gebruiken. Hiermee kunt u de software efficiënt en 'live' integreren.

De documentatie van onze API is beschikbaar op een verborgen pagina binnen de software. Deze bevat een stuk documentatie voorzien van testmogelijkheden.

Omdat onze API-mogelijkheden nog dagelijks bijgewerkt worden en de documentatie lang niet volledig is, adviseren wij u vóóraf contact op te nemen met één van onze consultants. Op basis van uw wensen kunnen wij u adviseren over de te kiezen werkwijze en/of voorzien van aanvullende API-mogelijkheden die elders of niet gedocumenteerd zijn. Ook kunnen wij op basis van onze (branche)ervaring adviseren om zo efficiënt mogelijk te werk te gaan.

Houd er rekening mee dat onze reguliere helpdesk weliswaar ondersteuning zal proberen te bieden, maar in beginsel ingericht is om storingen te verhelpen. Vragen over inrichting en ondersteuning hierbij zal via een vaste consultant verlopen die gedurende uw implementatie-traject beschikbaar is. Met hem/haar spreek je een periode af waarin de koppeling gebouwd is en er dus ondersteuning beschikbaar is. Naar wens is het middels een onderhoudscontract mogelijk deze specialistische ondersteuning beschikbaar te houden.

De API werkt bijzonder snel en heeft veel mogelijkheden tot efficiënt gebruik, zoals massa-acties, de mogelijkheid gerelateerde objecten direct mee te krijgen alsmede het ophalen van wijzigingen sinds een bepaald moment. Er zijn diverse websites gebouwd die Smart Trade als voornaamste of enige back-end geïntegreerd hebben.

Voor het gebruik van onze API zijn er enkele spelregels:

1. Gebruik de API zo beperkt als reëel. Uiteraard géén probleem om te zorgen dat je alle gegevens uitwisselt die je nodig hebt, maar haal niet het complete assortiment iedere x minuten op wanneer daar geen aanleiding toe is. Doe dit bijv. 1x per dag of week voor het hele assortiment, daarna uitsluitend op basis van wijzigingen. Of zorg dat het om een beperkte dataset gaat middels het toepassen van filters.
2. Gebruik een vorm van 'cache' of 'buffer' voor de stamgegevens waaronder (artikel)gegevens en bestanden (zoals afbeeldingen). Het is nadrukkelijk niet de bedoeling dat een webshopbezoek vertaald wordt als een API-call naar onze software.
3. Voor het werken met actuele gegevens beschikt de API over diverse handige werkwijzen. Zo kan je gewijzigde gegevens vanaf een bepaald moment ophalen. Handig voor bijvoorbeeld artikel- en voorraadgegevens. Ook is het mogelijk om de prijsafspraken van een zojuist ingelogde klant op te halen. Bestand-nummers wijzigen wanneer een bestand wijzigt, dus deze kan je bijvoorbeeld permanent cachen. Webhooks kunnen zorgen dat de webshop direct op hoogte is van eventuele mutaties.
4. Wij adviseren rekening te houden met de situatie dat onze software vertraagd functioneert en/of tijdelijk niet beschikbaar is. Hoewel dit (zéér) uitzonderlijk voorkomt, is het prettig wanneer een webshoporder veilig beschikbaar blijft en in het geval van storing op later moment gesynchroniseerd wordt. Daarnaast is het belangrijk dat uw applicatie geen requests blijft ophopen voor onze servers in het geval van een storing (DDoS), maar het op later moment opnieuw probeert.
5. Houd de toegangsgegevens tot onze API veilig in back-end van uw applicatie, uitsluitend in te zien tot daarvoor bevoegde personen,  en zorg dat deze niet gedeeld worden met client-side (javascript / client-apps).

Bent u op zoek naar een oplossing met meer flexibiliteit of ander type gegevensuitwisseling? Maak gebruik van onze krachtige Smart Connect software.