Pielāgotas API integrācijas

Integrējiet savu chatbot ar pielāgotiem API

Izmantojot mūsu AI darbību redaktoru, varat izveidot jebkuru pielāgotu integrāciju ar jebkuru aizmugursistēmu, kas spēj nodot datus, izmantojot API galapunktus. Piemēram, varat iestatīt, lai chatbot pārbaudītu preces pieejamību jūsu noliktavā, pasūtījuma statusu jūsu ERP sistēmā vai pašreizējo atlikumu klienta kontā.

Varat arī izpildīt darbības ārējo sistēmu atjaunināšanai - piemēram, izsaukt galapunktus, kas piesaka vizītes, vai nosūtīt Webhook pieprasījumus.

Priekšnosacījumi

ℹ️ Pirms sākat - pārliecinieties, ka jums ir ChatLab abonements, kas atbalsta Custom API integrācijas. Apskatiet cenu lapu

Custom API pievienošana jūsu chatbot

Pielāgota API integrācija ļauj jūsu chatbot sazināties ar ārējiem pakalpojumiem - piemēram, jūsu pielāgoto veikalu, iegūt datus vai veikt darbības lietotāja vārdā.

Šī pamācība soli pa solim parādīs, kā iestatīt pielāgotu API, izmantojot ChatLab platformu.

Jūsu API

Jums ir nepieciešami publiski pieejami API galapunkti, kurus var izsaukt chatbot - tas nozīmē, ka jums jānodrošina piekļuve datiem no savas e-komercijas platformas vai pielāgotās sistēmas, izmantojot API galapunktus, lai mūsu chatbot varētu izsaukt šos galapunktus, iegūt datus un sniegt tos jūsu lietotājiem.

Kā chatbot izsauc API

Lietotāju saziņas laikā chatbot dinamiski izsauks API atkarībā no nepieciešamības piekļūt ārējiem datiem vai veikt konkrētas darbības. Ir svarīgi ņemt vērā šādus nosacījumus:

• Izsaukums netiek garantēts: API tiks izsaukts tikai tad, kad chatbot loģika noteiks, ka tas ir nepieciešams. Netiek garantēts, kad vai cik bieži API tiks izsaukts.

• Prasības AI modelim: optimālai darbībai ieteicams izmantot augstāka līmeņa AI modeļus, kas atbalsta sarežģītus funkciju izsaukumus (function calling), piemēram, GPT-4o vai jaunākus. Šie modeļi daudz precīzāk spēj noteikt īsto brīdi API izsaukšanai, pamatojoties uz sarunas kontekstu un lietotāja nodomu.

• Kontekstjutīgi izsaukumi: chatbot mēģinās izsaukt API ikreiz, kad sarunā pamanīs kontekstu, kas atbilst API mērķim, taču faktiskais izsaukums būs atkarīgs no vairākiem faktoriem, piemēram:

  • Ārējā API pieejamības un atbildes ātruma.
  • Pašreizējā sarunas stāvokļa un lietotāja norādēm (prompts).
  • AI modeļa iekšējās pārliecības līmeņa un vērtēšanas algoritmiem, kas nosaka izsaukuma nepieciešamību.

Soļi Custom API iestatīšanai

1. solis: Dodieties uz Custom API iestatījumiem

1. Piesakieties savā ChatLab vadības panelī.

2. Kreisās puses sānjoslā sadaļā Settings (Iestatījumi) noklikšķiniet uz Custom API (Pielāgots API).

2. solis: Definējiet jaunu API

1. Noklikšķiniet uz pogas + Define API (+ Definēt API).

2. Laukā API Name (API nosaukums) ievadiet sava API nosaukumu.

3. Laukā URL norādiet ārējā pakalpojuma bāzes URL, ar kuru vēlaties izveidot savienojumu.

4. Noklikšķiniet uz Save (Saglabāt), lai izveidotu API.

3. solis: Pievienojiet API darbības

1. Tikko izveidotajā API ierakstā noklikšķiniet uz pogas View (Skatīt).

2. Noklikšķiniet uz + Define API Operation (+ Definēt API darbību), lai iestatītu atsevišķas darbības (galapunktus) šim API.

3. Aizpildiet nepieciešamo informāciju:

• Operation Name (Darbības nosaukums): aprakstošs darbības nosaukums.
• Operation URI (Darbības URI): darbības galapunkta ceļš (piemēram, /v1/resource).

4. solis: Konfigurējiet galapunkta URI un parametrus

1. Endpoint URI konfigurācija:

• Pievienojiet jebkurus darbībai nepieciešamos ceļa mainīgos, noklikšķinot uz + Add path variable (+ Pievienot ceļa mainīgo).
• Ievadiet mainīgā datus un, ja nepieciešams, atzīmējiet tos kā obligātus.

• Izvēlieties vērtības avotu:
  • Provided by user to chatbot - gadījumā, ja vērtība ir jāievada lietotājam sarunā ar chatbot.
  • Constant - gadījumā, ja tā ir konstanta vērtība, kas jums jānorāda brīdī, kad definējat API darbību.
• Pievienojiet jauno ceļa mainīgo ceļa definīcijā starp divām “@” zīmēm: @myvariable@:

1. Vaicājuma parametri (Query Parameters):

• Pievienojiet vaicājuma parametrus, noklikšķinot uz + Add query parameter (+ Pievienot vaicājuma parametru).
• Norādiet parametra nosaukumu, datu tipu un avotu (piemēram, saņemts no lietotāja vai chatbot).

5. solis: Iestatiet pieprasījuma metodi un pamattekstu (Body)

1. Izvēlieties darbībai atbilstošo HTTP metodi (piemēram, GET, POST).

2. Ja pieprasījuma metode ir POST, konfigurējiet pieprasījuma pamattekstu:

• Izvēlieties satura tipu (piemēram, application/json).
• Pievienojiet pamatteksta parametrus, norādot nosaukumu, datu tipu un avotu.

• Pievienojiet mainīgos pamatteksta definīcijai - parasti tas ir JSON formāts, kurā varat ievietot iepriekš definētos mainīgos.

6. solis: Iestatiet darbības galvenes (Headers)

Pievienojiet galvenes - piemēram, Authorization vai citas, ko pieprasa jūsu API. Lūdzu, aplūkojiet zemāk esošo ekrānuzņēmumu, lai redzētu, kā iestatīt pastāvīgu token galvenē Authorization:

7. solis: Saglabājiet darbību

1. Pārskatiet konfigurāciju, lai pārliecinātos, ka visa informācija ir pareiza.

2. Noklikšķiniet uz Save changes (Saglabāt izmaiņas), lai saglabātu API darbību.

8. solis: Pārbaudiet API integrāciju

1. Izmantojiet funkciju Test API (Pārbaudīt API), lai nosūtītu testa pieprasījumu un pārliecinātos, ka integrācija darbojas pareizi.

2. Pārraugiet žurnālus, vai tajos nav kļūdu vai problēmu, un vajadzības gadījumā pielāgojiet konfigurāciju.

9. solis: Piesaistiet API darbības savam chatbot

Kad API Operations ir definētas, ir pienācis laiks tās piesaistīt savam chatbot. Galvenajā chatbot vadības panelī atlasiet attiecīgo chatbot, noklikšķiniet uz Integrations (Integrācijas) un kreisās puses izvēlnē atlasiet AI API Actions (AI API darbības).

Izvēlētajai API darbībai noklikšķiniet uz Attach (Piesaistīt).

10. solis: Pievienojiet lomu norādījumus savam chatbot

Galvenajā chatbot vadības panelī atlasiet savu chatbot, noklikšķiniet uz Settings, kreisās puses izvēlnē atlasiet Role (Loma).

Noklikšķiniet uz Provide custom role instructions (Norādīt pielāgotus lomas norādījumus).

Pievienojiet norādījumus par jaunpievienotās API darbības izmantošanu. Piemēram, varat pievienot šādu nosacījumu:

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

Ieteikumi veiksmīgai integrācijai

• Pārliecinieties, ka bāzes URL un galapunkti ir pareizi un pieejami.

• Pārbaudiet, vai visas autentifikācijas prasības (piemēram, API atslēgas vai token) ir pareizi nokonfigurētas.

• Rūpīgi pārbaudiet katru darbību, lai pārliecinātos, ka tā atgriež gaidītās atbildes.

Veicot šīs darbības, jūs varat nevainojami integrēt pielāgotus API savā ChatLab chatbot, paplašinot tā funkcionalitāti un nodrošinot pilnvērtīgāku lietotāja pieredzi.

Jūsu Custom API integrācijas drošība

Lai nodrošinātu sava pielāgotā API drošību un aizsargātu to pret nesankcionētu piekļuvi, ņemiet vērā šo labo praksi:

Pastāvīgu token izmantošana

Pastāvīgie API token: iestatiet pastāvīgu API token (vai atslēgu), kas ir obligāts visiem pieprasījumiem uz API. Šim token jābūt unikālam un droši ģenerētam.

• Kā ieviest: iekļaujiet šo token pieprasījuma galvenē vai kā vaicājuma parametru katrā API izsaukumā.

• Kur glabāt: glabājiet token droši savos ChatLab iestatījumos kā darbības konstanto parametru.

Pieslēgšanās galapunkta izmantošana pagaidu token iegūšanai

Pievienojiet API papildu API darbību, kas atgriež pagaidu drošības token - t.i., pieslēgšanās galapunktu jūsu sistēmai.

Definējot šo API darbību, jums kā konstantie API darbības parametri būs jānorāda pieslēgšanās dati, kas atbilst jūsu sistēmai. Lai chatbot varētu izmantot šādā veidā iegūto token, jums jāpievieno drošības token citu API darbību definīcijās un jāpievieno atbilstoši norādījumi (prompt) gan pieslēgšanās darbībai, gan citām API darbībām (piemēram, “Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder”).

Sensitīvas informācijas kontrole ar ChatLab

Lai nepieļautu, ka chatbot parāda sensitīvu informāciju, ChatLab lietotāji var veikt šādas darbības:

Prompt inženierijas izmantošana AI uzvedības vadīšanai

• Nosakiet skaidrus norādījumus uzvednēs (prompts): konfigurējot chatbot, norādījumu iestatījumos sniedziet skaidras instrukcijas, lai netiktu rādīta nekāda sensitīva informācija. Piemēram:

  • Uzvednes piemērs: "Do not display any personal, financial, or confidential information returned by an API call."
  • Sistēmas ziņojumu izmantošana: sarunas plūsmas sākumā iekļaujiet sistēmas ziņojumu, lai uzsvērtu datu privātuma nozīmi (piemēram, "Ensure all outputs exclude any sensitive information.").

• Regulāri atjauniniet uzvednes: pielāgojiet uzvednes, pamatojoties uz lietotāju atsauksmēm vai izmaiņām datu jutīguma prasībās. Tas palīdz nodrošināt, ka AI konsekventi ievēro jaunākās vadlīnijas par rīkošanos ar sensitīvu informāciju.

API galapunktu izstrāde ar iebūvētu pārbaudes loģiku

• Pieprasiet lietotāja verifikāciju piekļuvei sensitīviem datiem: izstrādājiet savus API galapunktus tā, lai tie ietvertu verifikācijas pārbaudes pirms sensitīvu datu atgriešanas. Piemēram:

  • Verifikācijas parametri: pieprasiet lietotājiem norādīt konkrētu informāciju (piemēram, e-pasta adresi, pasūtījuma numuru vai konkrētu drošības jautājumu), pirms API atgriež ar šo lietotāju saistītos datus.
  • Vairākfaktoru verifikācija: ieviesiet papildu parametrus (piemēram, pasūtījuma datumu, piegādes adresi vai slepenu kodu), lai pārbaudītu lietotāja identitāti un pārliecinātos, ka viņam ir tiesības piekļūt datiem.

• Ieviesiet drošas kļūdu atbildes (fail-safe): iestatiet savu API loģiku tā, lai tā atgrieztu vispārīgus ziņojumus vai kļūdas, ja nepieciešamā verifikācija nav veikta vai nesakrīt:

  • Piemērs: "Unable to retrieve order details. Please verify your email and order number."

Ierobežotu datu apjomu izmantošana API atbildēs

• Samaziniet nodoto datu apjomu: konfigurējiet API atbildes tā, lai tajās tiktu iekļauti tikai chatbot funkcijas nodrošināšanai nepieciešamie dati, samazinot risku nejauši parādīt sensitīvu informāciju.
  • Piemērs: tā vietā, lai atgrieztu pilnus lietotāju profilus, atgrieziet tikai konkrētus laukus, piemēram, pasūtījuma statusu vai maksājuma apstiprinājumu, kas nepieciešami chatbot uzdevumam.