Docs en hulpKoppelen
SDK en API: welke koppeling gebruik je waarvoor?
Twee manieren om Neon Studio te gebruiken — de SDK op je eigen pagina en de Productie-API vanaf je eigen server. Wat het verschil is, en wanneer je wat pakt.
Er zijn twee manieren om Neon Studio aan je eigen systemen te knopen. De meeste makers hebben aan de eerste genoeg.
De SDK — voor op je website
De SDK is een klein JavaScript-bestand dat je in de pagina laadt waar je configurator moet komen. Het zet de configurator in een element op jouw pagina, met jouw prijzen, kleuren en teksten uit je portaal. Je bezoeker ontwerpt, en de bestelling komt bij Bestellingen & offertes binnen.
Wat de SDK voor je doet:
- De configurator op jouw pagina zetten: per product één code.
- De hoogte meebewegen met wat je klant doet, zodat je zelf niets hoeft in te stellen.
- Je instellingen live ophalen, zodat een prijswijziging meteen zichtbaar is zonder dat je iets opnieuw plakt.
De SDK draait bij je bezoeker in de browser en gebruikt daarom je publieke sleutel. Die hóórt op je website te staan: hij zegt alleen “deze bezoeker hoort bij dít bedrijf”. De code met je sleutel krijg je met Koppelen op de tab Gebruiken van je software. Zie Neon Studio in je eigen site zetten.
De Productie-API — voor je eigen systeem
De Productie-API is de koppeling tussen jouw server en je account. Hij is er nog niet: er is nog niets om aan te roepen, en je portaal biedt hem ook niet aan. Hij is bedoeld voor wat niet in een webpagina past:
- bestellingen uit je account in je eigen ERP of ordersysteem trekken;
- productiebestanden automatisch naar je machine of je werkmap halen;
- statussen bijwerken vanuit je eigen planning in plaats van met de hand.
De Productie-API werkt met een geheime sleutel. Die hoort op je server en nooit in een webpagina: iemand die hem heeft, praat met je hele account.
Welke pak je?
| Wat je wilt | Wat je pakt |
|---|---|
| Een configurator op je eigen site | SDK |
| Je klant laten bestellen zonder webshop | SDK |
| Elke nieuwe bestelling in je eigen systeem | De webhook |
| Bestanden automatisch ophalen | Productie-API (nog niet beschikbaar) |
Kun je niet programmeren? Dan is de SDK genoeg. Je plakt de code één keer en regelt de rest in je portaal op app.mark2form.com.
Het pakket op npm
De SDK staat op npm als @mark2form/sdk, met het element
<mark2form-configurator>. Versie 1 hoort vast bij het script v1.js: zolang
het versienummer met een 1 begint, blijft wat je bouwt werken. De opties die je
meegeeft en de gebeurtenissen waarop je kunt luisteren staan in de README van
dat pakket.
Voor de meeste makers is dat niet nodig. Neem de code gewoon over uit je portaal: daar staat de versie die vandaag klopt, met je sleutel erin.
Wat je zonder programmeren kunt doen:
- De configurator op je site zetten. Eén code, één keer plakken.
- Elke nieuwe bestelling doorsturen naar Zapier, Make, n8n of je eigen server, met de webhook.
Wil je meedenken over wat je nodig hebt? Laat het ons weten.
Wat wél vaststaat
- Je publieke sleutel hoort op je site; je geheime sleutel nooit.
- De runtime draait op embed.mark2form.com, in een venster binnen jouw pagina. Je bezoeker heeft geen account bij ons nodig en merkt er niets van.
- Alles wat je in je portaal instelt is direct actief. Je hoeft de code op je site nooit opnieuw te plakken.