API aansluiten

Leer meer over de API configurator en bekijk de standaard templates.

---

Met een API koppeling is de chatbot in staat om real-time informatie te halen uit andere software systemen.

Op basis van bepaalde variabelen, kan er specifieke informatie (gerelateerd aan deze variabelen) uit de software geraadpleegd worden. Deze informatie wordt vervolgens door AI gebruikt door om een antwoord te kunnen geven op de bezoekersvraag.

Denk bijvoorbeeld aan:

• De status van een specifieke bestelling uit een webshop

• De voorraad van een specifiek product uit een ERP

• De aankomende werkdagen van een specifiek personeelslid uit een planning systeem

• Etc.

Zoals kort behandeld bij de introductie van extra databronnen, kun je een API koppeling het beste vergelijken met een tool die de chatbot kan gebruiken.

Onderstaand een voorbeeld van een goede tool-omschrijving voor een productlijst.

Merk op dat je hier expliciet moet beschrijven welke variabelen de chatbot aan de bezoeker moet vragen alvorens hij de tool kan gebruiken.

Tool-omschrijving

Gebruik deze tool als een gebruiker informatie opvraagt over (de status van) een bestelling.

BELANGRIJK: Je kunt deze tool pas raadplegen als er een ordernummer EN een e-mailadres zijn doorgegeven door de gebruiker. Als een bezoeker slechts één van de twee variabelen doorgeeft, vraag je eerst aan de gebruiker om de ontbrekende gegevens  te sturen (order id en e-mailadres).

Vind hieronder templates van de meest gebruikte API koppelingen. Staat jouw systeem er niet bij? Stuur dan even een mailtje, dan helpen we je persoonlijk bij de koppeling!

WooCommerce order status API

Endpoint url

GET

https://WEBSITE.NL/wp-json/wc/v3/orders/{{order_id}}/?consumer_key=CONSUMER_KEY&consumer_secret=CONSUMER_SECRET

Headers

Uit

Auth protocol

None

Body-type

None

Variabelen

1: 
property: order_id 
beschrijving: Het ordernummer van de bestelling

2:
property: email
beschrijving: Het e-mailadres waarmee de bestelling geplaatst is

Output scheme

Aan

{
  "email": "billing.email",
  "order_id": "id",
  "date_created": "date_created",
  "status": "status",
  "shipping": "shipping"
}

E-mail validatie

Aan

E-mail key path: billing.email

Shopify order status API

Endpoint url

GET

https://STORENAAM.myshopify.com/admin/api/2024-04/orders.json?status=any&name={{order_id}}&status=any&fields=id,created_at,email,shipping_address,fulfillmentsLorem

Headers

Aan

1: 
key: Content-Type 
value: application/json

2: 
key: x-shopify-access-token
value: ACCESS TOKEN

Auth protocol

None

Body-type

None

Variabelen

1: 
property: order_id 
beschrijving: Het ordernummer van de bestelling

2:
property: email
beschrijving: Het e-mailadres waarmee de bestelling geplaatst is

Output scheme

Uit

E-mail validatie

Aan

E-mail key path: orders[0].email

Lightspeed order status API

Endpoint url

GET

https://api.sleak.chat/webhook/7793464b-c9c4-463e-8632-ed8927800fa9?username=API_KEY&password=API_SECRET&order={{order_id}}

Headers

Uit

Auth protocol

None

Body-type

None

Variabelen

1: 
property: order_id 
beschrijving: Het ordernummer van de bestelling

2:
property: email
beschrijving: Het e-mailadres waarmee de bestelling geplaatst is

Output scheme

Uit

E-mail validatie

Aan

E-mail key path: email

Sendcloud order status API

Endpoint url

GET

https://panel.sendcloud.sc/api/v2/parcels/?order_number={{order_id}}

Headers

Uit

Auth protocol

basic-auth

username: PUBLIC KEY
password: SECRET KEY

Body-type

None

Variabelen

1: 
property: order_id 
beschrijving: Het ordernummer van de bestelling

2:
property: email
beschrijving: Het e-mailadres waarmee de bestelling geplaatst is

Output scheme

Aan

{
  "tracking_nummer":"parcels[0].tracking_number",
  "tracking_url":"parcels[0].tracking_url",
  "order_id":"parcels[0].order_number",
  "email":"parcels[0].email",
  "naam":"parcels[0].name",
  "adres":"parcels[0].address",
  "postcode":"parcels[0].postal_code",
  "plaats":"parcels[0].city"
}

E-mail validatie

Aan

E-mail key path: parcels[0].email

Picqer order status API

Endpoint url

GET

https://SUBDOMEIN.picqer.com/api/v1/orders?reference={{order_id}}&emailaddress={{email}}

Headers

Uit

Auth protocol

None

Body-type

basic auth

username: API KEY
password:

Variabelen

1: 
property: order_id 
beschrijving: Het ordernummer van de bestelling

2:
property: email
beschrijving: Het e-mailadres waarmee de bestelling geplaatst is

Output scheme

Aan

{
  "status":"status",
  "trackingUrl":"public_status_page",
  "order_id":"reference",
  "naam":"deliveryname",
  "email":"emailaddress",
  "adres":"deliveryaddress",
  "postcode":"deliveryzipcode",
  "plaats":"deliverycity",
  "land":"deliverycountry"
}

E-mail validatie

Uit