Brugerdefinerede API-integrationer

Integrer din chatbot med tilpassede API'er

Ved hjælp af vores editor til AI-handlinger kan du bygge enhver tilpasset integration med ethvert backend-system, der kan udstille data via API-endpoints. For eksempel kan du få din chatbot til at tjekke tilgængeligheden af et produkt på dit lager, kontrollere ordrestatussen i dit ERP-system eller tjekke den aktuelle saldo på kundens konto.

Du kan også udføre handlinger for at opdatere eksterne systemer - for eksempel kalde endpoints, der opretter aftaler eller Webhooks.

Forudsætninger

ℹ️ Før du går i gang - sørg for, at du har et ChatLab-abonnement, der tillader Custom API-integrationer. Tjek prissiden

Tilføjelse af et Custom API til din chatbot

Integrering af et tilpasset API giver din chatbot mulighed for at kommunikere med eksterne tjenester - for eksempel din egen webshop, hente data eller udføre handlinger på vegne af brugeren.

Denne vejledning fører dig gennem de nødvendige trin til at opsætte et tilpasset API ved hjælp af ChatLab-platformen.

Dit API

Du skal have offentligt tilgængelige API-endpoints, som kan kaldes af din chatbot - det betyder, at du skal udstille data fra din e-handelsplatform eller dit tilpassede system via API-endpoints, så vores chatbot kan kalde disse endpoints for at hente disse data og give dem videre til dine brugere.

API-kald fra chatbotten

API'et vil blive kaldt dynamisk af chatbotten under brugerinteraktioner baseret på chatbottens behov for at tilgå eksterne data eller udføre specifikke handlinger. Det er vigtigt at bemærke følgende:

• Ingen garanti for kald: API'et vil kun blive kaldt, når chatbottens logik vurderer, at det er nødvendigt. Der er ingen garantier for, hvornår eller hvor ofte API'et vil blive kaldt.

• Krav til AI-modellen: For at opnå optimal ydeevne anbefales det at bruge mere avancerede AI-modeller, der understøtter komplekse funktionskald (function calling), såsom GPT-4o eller nyere. Disse modeller er bedre til at vurdere de rette tidspunkter til at kalde API'et baseret på samtalens kontekst og brugerens hensigt.

• Kontekstbevidste kald: Chatbotten vil forsøge at kalde API'et, hver gang den identificerer en kontekst i samtalen, der stemmer overens med API'ets formål, men det faktiske kald vil afhænge af flere faktorer, såsom:

  • Det eksterne API's tilgængelighed og svarhastighed.
  • Den aktuelle tilstand i samtalen og brugerens prompts.
  • AI-modellens interne konfidensniveauer og scoringsalgoritmer ved vurdering af nødvendigheden af kaldet.

Trin til opsætning af Custom API

Trin 1: Gå til Custom API-indstillingerne

1. Log ind på dit ChatLab-kontrolpanel.

2. Klik på Custom API i sidepanelet til venstre under sektionen Settings (Indstillinger).

Trin 2: Definer et nyt API

1. Klik på knappen + Define API (+ Definer API).

2. Indtast et navn til dit API i feltet API Name (API-navn).

3. Angiv basis-URL'en for den eksterne tjeneste, du vil oprette forbindelse til, i feltet URL.

4. Klik på Save (Gem) for at oprette API'et.

Trin 3: Tilføj API-handlinger

1. Klik på knappen View (Vis) i den nyoprettede API-post.

2. Klik på + Define API Operation (+ Definer API-handling) for at opsætte individuelle handlinger (endpoints) for dit API.

3. Udfyld de påkrævede oplysninger:

• Operation Name (Handlingsnavn): Et beskrivende navn for handlingen.
• Operation URI (Handlings-URI): Stien til endpointet for handlingen (f.eks. /v1/resource).

Trin 4: Konfigurer endpoint-URI og parametre

1. Konfiguration af endpoint-URI:

• Tilføj eventuelle stivariabler, der er nødvendige for handlingen, ved at klikke på + Add path variable (+ Tilføj stivariabel).
• Indtast variabeloplysningerne, og markér dem som påkrævede, hvis det er nødvendigt.

• Vælg værdikilden:
  • Provided by user to chatbot - hvis der kræves en værdi fra brugeren for at udfylde dette.
  • Constant - hvis dette er en konstant værdi, som du skal angive ved definitionen af din API-handling
• Tilføj den nyligt tilføjede stivariabel i stidefinitionen mellem to "@"-tegn: @myvariable@:

1. Forespørgselsparametre (Query Parameters):

• Tilføj eventuelle forespørgselsparametre ved at klikke på + Add query parameter (+ Tilføj forespørgselsparameter).
• Definer parameternavn, datatype og kilde (f.eks. angivet af brugeren eller chatbotten).

Trin 5: Vælg anmodningsmetode og brødtekst

1. Vælg HTTP-metoden for handlingen (f.eks. GET, POST).

2. Hvis anmodningsmetoden er POST, skal du konfigurere anmodningsbrødteksten (request body):

• Vælg indholdstype (f.eks. application/json).
• Tilføj parametrene for brødteksten, og angiv navn, datatype og kilde.

• Tilføj variablerne til brødtekstdefinitionen - det er normalt en json, hvor du kan placere de variabler, du har defineret

Trin 6: Angiv handlings-headers

Tilføj headers - f.eks. Authorization eller andre, der kræves af dit API. Se venligst skærmbilledet nedenfor for opsætning af et permanent token i Authorization-headeren:

Trin 7: Gem handlingen

1. Gennemgå konfigurationen for at sikre, at alle oplysninger er korrekte.

2. Klik på Save changes (Gem ændringer) for at gemme API-handlingen.

Trin 8: Test API-integrationen

1. Brug funktionen Test API (Test API) til at sende en testanmodning og sikre, at integrationen fungerer korrekt.

2. Hold øje med logfilerne for eventuelle fejl eller problemer, og tilpas konfigurationen efter behov.

Trin 9: Knyt API-handlingerne til chatbotten

Når du har defineret dine API Operations, er det tid til at tildele dem til chatbotten. Vælg chatbotten i det primære chatbot-kontrolpanel, klik på Integrations (Integrationer), og vælg AI API Actions (AI API-handlinger) i menuen til venstre

Klik på Attach (Tilknyt) på den valgte API-handling

Trin 10: Tilføj rolleinstruktioner til chatbotten

Vælg din chatbot i det primære chatbot-kontrolpanel, klik på Settings (Indstillinger), og vælg Role (Rolle) i menuen til venstre

Klik på Provide custom role instructions (Angiv tilpassede rolleinstruktioner).

Tilføj instruktioner om brugen af den nyligt tilføjede API-handling; du kan for eksempel tilføje en regel:

“- When user asks for store inventory always call getItems function and render the result of the function with following rules…..”

Tips til en vellykket integration

• Sørg for, at basis-URL og endpoints er korrekte og tilgængelige.

• Bekræft, at alle godkendelseskrav (som API-nøgler eller tokens) er konfigureret korrekt.

• Test hver handling grundigt for at sikre, at den returnerer de forventede svar.

Ved at følge disse trin kan du problemfrit integrere tilpassede API'er i din ChatLab-chatbot, hvilket udvider dens funktionalitet og giver en bedre brugeroplevelse.

Sikring af din Custom API-integration

For at sikre, at dit tilpassede API er sikkert og beskyttet mod uautoriseret adgang, bør du overveje følgende bedste praksisser:

Brug konstante tokens

Konstante API-tokens: Opret et konstant API-token (eller en nøgle), som er påkrævet for alle anmodninger til API'et. Dette token skal være unikt og genereret sikkert.

• Sådan implementeres det: Inkluder tokenet i anmodnings-headeren eller som en forespørgselsparameter i hvert API-kald.

• Hvor det skal gemmes: Gem tokenet sikkert i dine ChatLab-indstillinger som en konstant parameter for handlingen

Brug et login-endpoint til midlertidige tokens

Tilføj en ekstra API-handling til API'et, som returnerer et midlertidigt sikkerhedstoken - dvs. et login-endpoint til dit system.

Du skal angive dine loginoplysninger, der matcher dit system, som konstante parametre for API-handlingen, når du definerer denne API-handling. For at chatbotten kan bruge det token, der opnås på denne måde, skal du tilføje et sikkerhedstoken i definitionerne af andre API-handlinger og tilføje de rette promptinstruktioner til loginhandlingen såvel som til de andre API-handlinger (for eksempel “Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder”).

Kontrol af følsomme oplysninger via ChatLab

For at forhindre, at følsomme oplysninger vises af chatbotten, kan ChatLab-brugere tage følgende forholdsregler:

Brug prompt engineering til at styre AI-adfærden

• Angiv klare instruktioner i prompts: Når du konfigurerer chatbotten, skal du give eksplicitte instruktioner i promptindstillingerne for at undgå visning af følsomme oplysninger. For eksempel:

  • Eksempel på prompt: "Do not display any personal, financial, or confidential information returned by an API call."
  • Brug af systemmeddelelser: Inkluder en systemmeddelelse i begyndelsen af samtaleflowet for at understrege vigtigheden af databeskyttelse (f.eks. "Ensure all outputs exclude any sensitive information.").

• Opdater prompts regelmæssigt: Tilpas dine prompts baseret på brugerfeedback eller ændringer i kravene til datafølsomhed. Dette hjælper med at sikre, at AI'en konsekvent følger de nyeste retningslinjer for håndtering af følsomme oplysninger.

Design API-endpoints med indbygget verifikationslogik

• Kræv brugerverifikation for adgang til følsomme data: Design dine API-endpoints, så de inkluderer verifikationstjek, før de returnerer følsomme data. For eksempel:

  • Verifikationsparametre: Kræv, at brugerne angiver bestemte oplysninger (såsom en e-mailadresse, et ordrenummer eller et specifikt sikkerhedsspørgsmål), før API'et returnerer data relateret til den pågældende bruger.
  • Multifaktor-verifikation: Implementer yderligere parametre (f.eks. ordredato, leveringsadresse eller en hemmelig kode) for at bekræfte brugerens identitet og sikre, at vedkommende har tilladelse til at tilgå dataene.

• Implementer fejlsikre svar: Konfigurer din API-logik til at returnere generiske meddelelser eller fejl, hvis den påkrævede verifikation ikke angives eller ikke matcher:

  • Eksempel: "Unable to retrieve order details. Please verify your email and order number."

Brug begrænsede dataomfang i API-svar

• Minimer dataeksponering: Konfigurer API-svar til kun at indeholde de data, der er nødvendige for chatbottens funktion, for at mindske risikoen for utilsigtet visning af følsomme oplysninger.
  • Eksempel: I stedet for at returnere fulde brugerprofiler bør du kun returnere specifikke felter som ordrestatus eller betalingsbekræftelse, der er nødvendige for chatbottens opgave.