Tilpassede API-integrasjoner

Integrer chatboten din med tilpassede API-er

Ved hjelp av vår redigering for AI-handlinger kan du bygge enhver tilpasset integrasjon med et hvilket som helst baksystem som kan eksponere data via API-endepunkter. Du kan for eksempel få chatboten til å sjekke tilgjengeligheten av et produkt på lageret ditt, sjekke ordrestatusen i ERP-systemet ditt eller sjekke gjeldende saldo på kundekontoen.

Du kan også utføre handlinger for å oppdatere eksterne systemer - for eksempel kalle endepunkter som oppretter avtaler eller Webhooks.

Forutsetninger

ℹ️ Før du starter - sørg for at du har et ChatLab-abonnement som tillater tilpassede API-integrasjoner. Sjekk prissiden

Legge til et tilpasset API i chatboten din

Integrering av et tilpasset API lar chatboten din kommunisere med eksterne tjenester - for eksempel din egen nettbutikk, hente data eller utføre handlinger på vegne av brukeren.

Denne veiledningen tar deg gjennom trinnene som kreves for å sette opp et tilpasset API ved hjelp av ChatLab-plattformen.

Ditt API

Du må ha offentlig tilgjengelige API-endepunkter som kan kalles av chatboten - dette betyr at du må eksponere data fra din e-handelsplattform eller ditt eget system via API-endepunkter, slik at chatboten vår kan kalle disse endepunktene for å hente ut dataene og gi dem til brukerne dine.

API-kall fra chatboten

API-et vil bli kalt dynamisk av chatboten under brukersamtaler basert på chatbotens behov for å få tilgang til eksterne data eller utføre bestemte handlinger. Det er viktig å merke seg følgende:

• Ingen garantert kjøring: API-et kalles bare når chatbotens logikk avgjør at det er nødvendig. Det finnes ingen garantier for når eller hvor ofte API-et vil bli kalt.

• Krav til AI-modell: For optimal ytelse anbefales det å bruke mer avanserte AI-modeller som støtter komplekse funksjonskall, for eksempel GPT-4o eller nyere. Disse modellene er flinkere til å avgjøre når det passer å kalle API-et basert på konteksten i samtalen og brukerens hensikt.

• Kontekstbevisste kall: Chatboten vil prøve å kalle API-et når den identifiserer en kontekst i samtalen som samsvarer med API-ets formål, men det faktiske kallet avhenger av flere faktorer, for eksempel:

  • Tilgjengeligheten og responstiden til det eksterne API-et.
  • Den nåværende tilstanden i samtalen og brukerens ledetekster.
  • Interne konfidensnivåer og poengalgoritmer i AI-modellen når den vurderer om kallet er nødvendig.

Trinn for å sette opp Custom API

Trinn 1: Gå til Custom API-innstillingene

1. Logg inn på ditt ChatLab-dashbord.

2. I sidemenyen til venstre, under seksjonen Settings (Innstillinger), klikker du på Custom API (Tilpasset API).

Trinn 2: Definer et nytt API

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

2. Skriv inn et navn på API-et ditt i feltet API Name (API-navn).

3. Oppgi basis-URL-en til den eksterne tjenesten du vil koble til, i feltet URL.

4. Klikk på Save (Lagre) for å opprette API-et.

Trinn 3: Legg til API-operasjoner

1. I den nyopprettede API-oppføringen klikker du på knappen View (Vis).

2. Klikk på + Define API Operation (+ Definer API-operasjon) for å sette opp individuelle operasjoner (endepunkter) for API-et.

3. Fyll ut de nødvendige opplysningene:

• Operation Name (Operasjonsnavn): Et beskrivende navn på operasjonen.
• Operation URI (Operasjons-URI): Endepunktbanen for operasjonen (f.eks. /v1/resource).

Trinn 4: Konfigurer endepunkt-URI og parametere

1. Konfigurasjon av endepunkt-URI:

• Legg til eventuelle banevariabler som trengs for operasjonen, ved å klikke på + Add path variable (+ Legg til banevariabel).
• Skriv inn variabeldetaljene og merk dem som obligatoriske om nødvendig.

• Velg verdikilde:
  • Provided by user to chatbot - i tilfelle en verdi fra brukeren kreves for å fylle ut dette.
  • Constant - i tilfelle dette er en konstant verdi som du må oppgi når du definerer API-operasjonen
• Legg til den nye banevariabelen i banedefinisjonen mellom to «@»-tegn: @myvariable@:

1. Spørringsparametere:

• Legg til eventuelle spørringsparametere ved å klikke på + Add query parameter (+ Legg til spørringsparameter).
• Definer parameternavn, datatype og kilde (f.eks. oppgitt av brukeren eller chatboten).

Trinn 5: Angi forespørselsmetode og brødtekst

1. Velg HTTP-metode for operasjonen (f.eks. GET, POST).

2. Hvis forespørselsmetoden er POST, konfigurerer du forespørselsbrødteksten:

• Velg innholdstype (f.eks. application/json).
• Legg til parametere for brødteksten, og angi navn, datatype og kilde.

• Legg til variablene i brødtekstdefinisjonen - det er vanligvis en json der du kan plassere variablene du har definert

Trinn 6: Angi operasjonshoder

Legg til hoder - f.eks. Authorization eller andre som kreves av API-et ditt. Se på skjermbildet nedenfor for oppsett av et permanent token i Authorization-hodet:

Trinn 7: Lagre operasjonen

1. Se over konfigurasjonen for å sikre at alle detaljer er riktige.

2. Klikk på Save changes (Lagre endringer) for å lagre API-operasjonen.

Trinn 8: Test API-integrasjonen

1. Bruk funksjonen Test API (Test API) til å sende en testforespørsel og bekrefte at integrasjonen fungerer som den skal.

2. Følg med i loggene etter eventuelle feil eller problemer, og juster konfigurasjonen etter behov.

Trinn 9: Koble API-operasjonene til chatboten

Når du har definert API Operations (API-operasjoner), er det på tide å tilordne dem til chatboten. Velg chatboten i hoveddashbordet for chatboter, klikk på Integrations (Integrasjoner) og velg AI API Actions (AI API-handlinger) i menyen til venstre

Klikk på Attach (Koble til) på den valgte API-operasjonen

Trinn 10: Legg til rolleinstruksjoner for chatboten

Velg chatboten din i hoveddashbordet for chatboter, klikk på Settings (Innstillinger), og velg Role (Rolle) i menyen til venstre

Klikk på Provide custom role instructions (Oppgi tilpassede rolleinstruksjoner).

Legg til instruksjoner for bruk av den nylig tilknyttede API-operasjonen, for eksempel kan du legge til en regel:

«- Når brukeren spør etter varebeholdning i butikken, skal du alltid kalle funksjonen getItems og gjengi resultatet av funksjonen med følgende regler…..»

Tips for en vellykket integrasjon

• Sørg for at basis-URL og endepunkter er riktige og tilgjengelige.

• Kontroller at eventuelle autentiseringskrav (som API-nøkler eller tokens) er riktig konfigurert.

• Test hver operasjon grundig for å sikre at den returnerer de forventede svarene.

Ved å følge disse trinnene kan du sømløst integrere tilpassede API-er i ChatLab-chatboten din, utvide funksjonaliteten og gi en bedre brukeropplevelse.

Sikre din tilpassede API-integrasjon

For å sikre at det tilpassede API-et ditt er trygt og beskyttet mot uautorisert tilgang, bør du vurdere følgende beste praksiser:

Bruk faste tokens

Faste API-tokens: Sett opp et fast API-token (eller nøkkel) som kreves for alle forespørsler til API-et. Dette tokenet bør være unikt og generert på en sikker måte.

• Hvordan implementere: Inkluder tokenet i forespørselshodet eller som en spørringsparameter i hvert API-kall.

• Hvor det skal lagres: Lagre tokenet sikkert i ChatLab-innstillingene dine som en konstant parameter for operasjonen

Bruk et innloggingsendepunkt for midlertidige tokens

Legg til en ekstra API-operasjon i API-et som returnerer et midlertidig sikkerhetstoken - dvs. et innloggingsendepunkt til systemet ditt.

Du må oppgi innloggingsopplysningene dine som samsvarer med systemet ditt som konstante parametere når du definerer denne API-operasjonen. For at chatboten skal kunne bruke tokenet som er hentet på denne måten, må du legge til et sikkerhetstoken i definisjonene av andre API-operasjoner og legge til riktige prompt-instruksjoner i innloggingsoperasjonen så vel som i de andre API-operasjonene (for eksempel «Bruk alltid sikkerhetstokenet hentet fra Login-operasjonen som parameteren security_token for operasjonen getOrder»).

Kontrollere sensitiv informasjon gjennom ChatLab

For å forhindre at sensitiv informasjon vises av chatboten, kan ChatLab-brukere gjøre følgende tiltak:

Bruk prompt engineering for å styre AI-ens atferd

• Angi klare instruksjoner i ledetekster: Når du konfigurerer chatboten, bør du gi eksplisitte instruksjoner i prompt-innstillingene for å unngå at sensitiv informasjon vises. For eksempel:

  • Eksempel på ledetekst: «Ikke vis noen personlige, økonomiske eller konfidensielle opplysninger som returneres fra et API-kall.»
  • Bruk av systemmeldinger: Inkluder en systemmelding i starten av samtalehistorikken for å forsterke betydningen av personvern (f.eks. «Sørg for at alle svar utelater enhver sensitiv informasjon.»).

• Oppdater ledetekster regelmessig: Juster ledetekstene basert på tilbakemeldinger fra brukere eller endringer i krav til datasensitivitet. Dette bidrar til at AI-en konsekvent følger de nyeste retningslinjene for håndtering av sensitiv informasjon.

Utform API-endepunkter med innebygd verifiseringslogikk

• Krev brukerverifisering for tilgang til sensitive data: Utform API-endepunktene dine slik at de inkluderer verifiseringskontroller før de returnerer sensitive data. For eksempel:

  • Verifiseringsparametere: Krev at brukere oppgir viss informasjon (som en e-postadresse, ordrenummer eller et bestemt sikkerhetsspørsmål) før API-et returnerer data knyttet til den brukeren.
  • Flerfaktorverifisering: Implementer ekstra parametere (f.eks. ordredato, leveringsadresse eller en hemmelig kode) for å bekrefte brukerens identitet og sikre at vedkommende har autorisasjon til å få tilgang til dataene.

• Implementer feilsikre svar: Angi at API-logikken skal returnere generiske meldinger eller feil hvis den påkrevde verifiseringen ikke oppgis eller ikke samsvarer:

  • Eksempel: «Kunne ikke hente ordredetaljer. Vennligst bekreft e-postadressen og ordrenummeret ditt.»

Bruk begrensede dataomfang i API-svar

• Minimer dataeksponering: Konfigurer API-svar til kun å inkludere dataene som er nødvendige for chatbotens funksjon, slik at du reduserer risikoen for utilsiktet visning av sensitiv informasjon.
  • Eksempel: I stedet for å returnere fulle brukerprofiler, returner kun spesifikke felt som ordrestatus eller betalingsbekreftelse som er nødvendige for chatbotens oppgave.