Anpassade API-integrationer

Integrera din chattbot med anpassade API:er

Med vår redigerare för AI-åtgärder kan du bygga valfri anpassad integration med vilket backend-system som helst som kan tillhandahålla data via API-slutpunkter. Du kan till exempel låta chattbotten kontrollera produkttillgänglighet i ditt lager, kontrollera orderstatus i ditt ERP-system eller kontrollera aktuellt saldo på kundens konto.

Du kan också köra åtgärder för att uppdatera externa system - till exempel anropa slutpunkter som bokar möten eller webhooks.

Förutsättningar

ℹ️ Innan du börjar - se till att du har en ChatLab-prenumeration som tillåter anpassade API-integrationer. Se prissidan

Lägga till ett anpassat API till din chattbot

Genom att integrera ett anpassat API kan din chattbot kommunicera med externa tjänster - till exempel din egen webbutik, hämta data eller utföra åtgärder för användarens räkning.

Den här guiden går igenom stegen som krävs för att konfigurera ett anpassat API med ChatLab-plattformen.

Ditt API

Du behöver ha offentligt tillgängliga API-slutpunkter som kan anropas av chattbotten - det innebär att du behöver exponera data från din e-handelsplattform eller ditt eget system via API-slutpunkter så att vår chattbot kan anropa dessa slutpunkter för att hämta informationen och ge den till dina användare.

API-anrop från chattbotten

API:et anropas dynamiskt av chattbotten under användarinteraktioner baserat på chattbottens behov av att komma åt externa data eller utföra specifika åtgärder. Det är viktigt att notera följande:

• Inga garanterade anrop: API:et anropas endast när chattbottens logik bedömer att det är nödvändigt. Det finns inga garantier för när eller hur ofta API:et kommer att anropas.

• Krav på AI-modell: För optimal prestanda rekommenderas mer avancerade AI-modeller som har stöd för komplexa funktionsanrop, till exempel GPT-4o eller högre. Dessa modeller är bättre på att avgöra lämpliga tillfällen att anropa API:et utifrån konversationens sammanhang och användarens avsikt.

• Kontextmedvetna anrop: Chattbotten försöker anropa API:et varje gång den identifierar ett sammanhang i konversationen som stämmer överens med API:ets syfte, men det faktiska anropet beror på flera faktorer, till exempel:

  • Tillgänglighet och svarstid för det externa API:et.
  • Den aktuella statusen för konversationen och användarens frågor.
  • AI-modellens interna konfidensnivåer och poängalgoritmer när den beslutar om anropet är nödvändigt.

Steg för att konfigurera anpassat API

Steg 1: Gå till inställningarna för Custom API

1. Logga in på din ChatLab-panel.

2. I sidofältet till vänster, under sektionen Settings (Inställningar), klickar du på Custom API (Anpassat API).

Steg 2: Definiera ett nytt API

1. Klicka på knappen + Define API (+ Definiera API).

2. Ange ett namn för ditt API i fältet API Name (API-namn).

3. Ange bas-URL:en för den externa tjänst du vill ansluta till i fältet URL.

4. Klicka på Save (Spara) för att skapa API:et.

Steg 3: Lägg till API-operationer

1. Klicka på knappen View (Visa) på den nyskapade API-posten.

2. Klicka på + Define API Operation (+ Definiera API-operation) för att konfigurera enskilda operationer (slutpunkter) för API:et.

3. Fyll i nödvändiga uppgifter:

• Operation Name: Ett beskrivande namn för operationen.
• Operation URI: Slutpunktens sökväg för operationen (t.ex. /v1/resource).

Steg 4: Konfigurera slutpunktens URI och parametrar

1. Konfiguration av slutpunktens URI:

• Lägg till eventuella sökvägsvariabler som behövs för operationen genom att klicka på + Add path variable (+ Lägg till sökvägsvariabel).
• Ange variabeluppgifterna och markera dem som obligatoriska vid behov.

• Välj värdekälla:
  • Provided by user to chatbot - om det krävs ett värde från användaren för att fylla i detta.
  • Constant - om detta är ett konstant värde som du behöver ange när API-operationen definieras
• Lägg till den nyligen tillagda sökvägsvariabeln i sökvägsdefinitionen mellan två ”@”-tecken: @minvariabel@:

1. Frågeparametrar (Query Parameters):

• Lägg till eventuella frågeparametrar genom att klicka på + Add query parameter (+ Lägg till frågeparameter).
• Ange parameternamn, datatyp och källa (t.ex. tillhandahållen av användaren eller chattbotten).

Steg 5: Ange anropsmetod och body

1. Välj HTTP-metod för operationen (t.ex. GET, POST).

2. Om anropsmetoden är POST konfigurerar du anropets body:

• Välj innehållstyp (t.ex. application/json).
• Lägg till parametrarna för body och ange namn, datatyp och källa.

• Lägg till variablerna i body-definitionen - det är vanligtvis en JSON där du kan placera de variabler du har definierat

Steg 6: Ange headers för operationen

Lägg till headers - t.ex. Authorization eller andra som krävs av ditt API. Se skärmbilden nedan för hur du ställer in en permanent token i Authorization-headern:

Steg 7: Spara operationen

1. Kontrollera konfigurationen för att säkerställa att alla uppgifter är korrekta.

2. Klicka på Save changes (Spara ändringar) för att spara API-operationen.

Steg 8: Testa API-integrationen

1. Använd funktionen Test API (Testa API) för att skicka en testförfrågan och kontrollera att integrationen fungerar som den ska.

2. Håll koll i loggarna efter eventuella fel eller problem och justera konfigurationen efter behov.

Steg 9: Koppla API-operationerna till chattbotten

När du har definierat dina API Operations är det dags att tilldela dem till chattbotten. Välj chattbotten i huvudöversikten över chattbottar, klicka på Integrations (Integrationer) och välj AI API Actions (AI API-åtgärder) i menyn till vänster

Klicka på Attach (Koppla) på den valda API-operationen

Steg 10: Lägg till rollinstruktioner för chattbotten

Välj din chattbot i huvudöversikten över chattbottar, klicka på Settings (Inställningar) och välj Role (Roll) i menyn till vänster

Klicka på Provide custom role instructions. (Ange anpassade rollinstruktioner.)

Lägg till instruktioner om hur den nyligen tillagda API-operationen ska användas, du kan till exempel lägga till en regel:

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

Tips för en lyckad integration

• Kontrollera att bas-URL och slutpunkter är korrekta och åtkomliga.

• Verifiera att alla autentiseringskrav (som API-nycklar eller tokens) är korrekt konfigurerade.

• Testa varje operation noggrant för att säkerställa att den returnerar förväntade svar.

Genom att följa dessa steg kan du smidigt integrera anpassade API:er i din ChatLab-chattbot, vilket utökar dess funktionalitet och ger en rikare användarupplevelse.

Säkra din anpassade API-integration

För att säkerställa att ditt anpassade API är säkert och skyddat mot obehörig åtkomst bör du tänka på följande rekommendationer:

Använd konstanta tokens

Konstanta API-tokens: Konfigurera en konstant API-token (eller nyckel) som krävs för alla anrop till API:et. Denna token ska vara unik och genereras på ett säkert sätt.

• Hur du implementerar det: Inkludera token i anropets header eller som en frågeparameter i varje API-anrop.

• Var den ska lagras: Spara din token säkert i dina ChatLab-inställningar som en konstant parameter för operationen

Använd inloggningsslutpunkt för tillfälliga tokens

Lägg till ytterligare en API-operation i API:et som returnerar en tillfällig säkerhetstoken - d.v.s. en inloggningsslutpunkt till ditt system.

Du behöver ange dina inloggningsuppgifter som matchar ditt system som konstanta parametrar när du definierar denna API-operation. För att chattbotten ska kunna använda den token som erhållits på detta sätt behöver du lägga till säkerhetstoken i definitionerna för övriga API-operationer samt lägga till lämpliga promptinstruktioner för både inloggningsoperationen och de andra API-operationerna (Till exempel: ”Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder”).

Styra känslig information via ChatLab

För att förhindra att känslig information visas av chattbotten kan ChatLab-användare vidta följande åtgärder:

Använd prompt engineering för att styra AI-beteendet

• Ange tydliga instruktioner i prompter: När du konfigurerar chattbotten anger du explicita instruktioner i promptinställningarna för att undvika att känslig information visas. Till exempel:

  • Exempel på prompt: ”Do not display any personal, financial, or confidential information returned by an API call.”
  • Användning av systemmeddelanden: Lägg till ett systemmeddelande i början av konversationsflödet för att förstärka vikten av datasekretess (t.ex. ”Ensure all outputs exclude any sensitive information.”).

• Uppdatera prompter regelbundet: Justera prompterna baserat på feedback från användare eller ändrade krav kring datakänslighet. Detta säkerställer att AI-modellen konsekvent följer de senaste riktlinjerna för hantering av känslig information.

Utforma API-slutpunkter med inbyggd verifieringslogik

• Kräv användarverifiering för åtkomst till känsliga data: Utforma dina API-slutpunkter så att de innehåller verifieringskontroller innan känsliga data returneras. Till exempel:

  • Verifieringsparametrar: Kräv att användare anger viss information (såsom e-postadress, ordernummer eller en specifik säkerhetsfråga) innan API:et returnerar data kopplad till den användaren.
  • Flerfaktorsverifiering: Implementera ytterligare parametrar (t.ex. orderdatum, leveransadress eller en hemlig kod) för att verifiera användarens identitet och säkerställa att personen har behörighet att ta del av informationen.

• Implementera felsäkra svar: Ställ in din API-logik på att returnera generiska meddelanden eller felmeddelanden om den obligatoriska verifieringen inte anges eller inte stämmer:

  • Exempel: ”Unable to retrieve order details. Please verify your email and order number.”

Använd begränsad dataomfattning i API-svar

• Minimera dataexponering: Konfigurera API-svaren så att de endast innehåller de data som behövs för chattbottens funktion, vilket minskar risken för att känslig information oavsiktligt visas.
  • Exempel: Istället för att returnera fullständiga användarprofiler returnerar du endast specifika fält som orderstatus eller betalningsbekräftelse som krävs för chattbottens uppgift.