Hoe gebruik je het Sendcloud Actie sjabloon?

Dit artikel zal je begeleiden bij het gebruik van het Sendcloud Actie sjabloon.

Door dit sjabloon te gebruiken, kun je eenvoudig verbinding maken met je Sendcloud-database om informatie over de orderstatus op te halen. Dit sjabloon is vooraf ingevuld met alle noodzakelijke informatie, zodat je gesprekken naadloos kunt automatiseren. Je zult echter zelf enkele gegevens moeten invullen om verbinding te kunnen maken met je specifieke database.

Het Gebruik van het Sendcloud Actie sjabloon

Stap 1: Toegang krijgen tot de sjabloon

In je chatbot in Pulse, navigeer naar Acties. Hier kun je de Sendcloud-sjabloon vinden en selecteren. Dit sjabloon bevat vooraf ingevulde informatie die nodig is om de orderstatus uit je Sendcloud-database op te halen.

 

Stap 2: Vul de vereiste velden in

  • BaseURL: Voer de BaseURL in voor je Sendcloud API. Dit is het eindpunt waar de actie verzoeken naartoe zal sturen om orderinformatie op te halen.
    Je kunt de BaseURL vinden door onderstaande stappen te doorlopen:
    1. Log in op je Sendcloud-beheerpaneel.
    2. Ga naar Instellingen > API > API Eindpunten.
    3. Hier vind je de base URL. De base URL heeft meestal dit formaat: https://jouwdomein.com/api/v1/
           Voorbeeld van een Base URL: https://voorbeeld.com/api/v1/
  • Authenticatie: Vul de noodzakelijke inloggegevens in: 'public_key' en 'password'. Deze kun je vinden in de Sendcloud API-documentatie.
  • Health Check URL en Instructie:
    • Health Check URL: Definieer een health check URL om de status van de externe server te monitoren. Deze URL controleert of de server online is.

      Net als de Base URL kan de Health Check URL worden geconstrueerd door het health check eindpunt aan je Base URL toe te voegen.
      Voorbeeld van een Health Check URL: https://voorbeeld.com/api/v1/health_check
    • Health Check Instructie: Voeg een instructie toe voor de chatbot om te volgen als de server niet online is. Bijvoorbeeld, je kunt de chatbot instrueren om te reageren met: "Sorry, er is iets misgegaan aan onze kant. Kan ik je ergens anders mee helpen?"

Stap 3: Werk het schema bij

Het sjabloon wordt geleverd met een vooraf ingevuld schema, dat je een voorbeeld geeft. Je hebt mogelijk een ontwikkelaar nodig om het aan te passen aan je specifieke vereisten. Zorg ervoor dat het schema in .YML-formaat is en voldoet aan ten minste OpenAPI versie 3.0.0.

Stap 4: Je actie valideren

Na het invullen van de vereiste details en het schema:

  1. Valideren: Klik op de knop "Valideren" om te controleren op eventuele fouten in je schema. Corrigeer eventuele geïdentificeerde problemen.
  2. Beschikbare Acties: Zodra gevalideerd, worden de beschikbare acties weergegeven.

Je kunt dit artikel gebruiken om je te helpen de actie op te slaan, te publiceren en te de-publiceren, en om de actie te testen en te gebruiken.