Integrācija ar trešo pušu API

Jūs varat izveidot botus, kas mijiedarbojas ar citiem resursiem, izmantojot API. Piemēram, boti var apstrādāt pieprasījumus, pārbaudot, vai ir iespējams izveidot tikšanos noteiktā datumā, vai atrast preci interneta veikalā.

Kā apstrādāt trešās puses API, izmantojot DaData piemēru

Ņemsim API padomus no https://dadata.ru/api/suggest/address kā piemēru

Uzmanīgi izlasiet trešo pušu API dokumentāciju

Atveriet savu projektu Mavibot un atveriet bloka iestatījumos papildu iestatījumus; tur jums jāmaina pieprasījuma veids uz POST-json.

Laukā “URL pieprasījums” ievadiet šādu URL: https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/address

Laukā “Pieprasījuma galvene” ievadiet galveni JSON formātā:

{ "Content-Type": "application/json", "Accept": "application/json", "Authorization": "Token " + token }

Laukā “JSON parametri” ievietojiet pašu pieprasījumu - { "query": "#{CurrencyType}" }

Lai iegūtu rezultātus, jums būs jāaizpilda arī cilne “Saglabātās vērtības”.

Pieprasījuma piemērs ir zemāk:

Kā saglabāt vērtības no mainīgajiem

Ne visiem tas uzreiz izdodas, kamēr neizmēģināt to izdarīt paši.

Lai sāktu, atbildes laukā ierakstiet #{custom_answer}. (Mainīgais #{custom_answer} satur atbildi, kas saņemta no servera, kas tika minēts laukā “URL atbildei no servera”)

Palaidiet bloku ar pieprasījumu, lai nosūtītu pieprasījumu un saņemtu uz to atbildi. Jums jāanalizē atbilde un jāiestata piekļuve tajā esošajiem mainīgajiem. Šim nolūkam jums jāstrādā ar cilni “Saglabātās vērtības”.

Apskatīsim piemēru, lai labāk izprastu procesu.

Mūsu pieprasījuma #{custom_answer} rezultātā tika saņemta šāda formāta atbilde:

{"suggestions": [{"value": "British pound", "unrestricted_value": "British pound", "data": {"code": "826", "strcode": "GBP", "name": "British pound", "country": "The UK"}}]}

Tagad ierakstīsim laukā “Saglabātās vērtības” mūsu VĒRTĪBA->MAINĪGAIS

suggestions - masīva atslēga [{"value": "British pound", "unrestricted_value": "British pound", "data": {"code": "826", "strcode": "GBP", "name": "British pound", "country": "The UK"}}]

suggestions|0 - pirmā elementa atslēga masīvā {"value": "British pound", "unrestricted_value": "British pound", "data": {"code": "826", "strcode": "GBP", "name": "British pound", "country": "The UK"}}

suggestions|0|value - atslēga vērtībai “British pound”

Garākā atslēga šajā JSON:

suggestions|0|data|strcode - atslēga vērtībai “GBP”

Atslēgas tiek atdalītas ar vertikālo līniju (|). Ja JSON ir masīvs, tad piekļuve tā elementam tiek numurēta, sākot ar skaitli 0, un to arī raksta ar vertikālo līniju.

Ir nepieciešams atkārtot visu ligzdošanu. Ērtības labad varat vizualizēt JSON lietotnē JSON-viewer.

Ligzdošanas līmeņi tiek atdalīti ar vertikālām līnijām. Tātad, lai nokļūtu līdz vērtībai, jums jāuzskaita visas atslēgas, kas atdalītas ar līniju.

Ja JSON ir masīvs, tad atslēgas vietā jāmin elementa numurs, sākot ar 0.

Atdaliet mainīgo iegūšanas frāzes ar semikolu (;). Frāzes sastāv no saites uz datiem atbildē un mainīgā nosaukuma, kurā to saglabāt, kas ir atdalīti ar simboliem -> (domuzīme + leņķa iekava).

Meklēšanas vaicājums savā ziņā ir ceļš JSON līdz vajadzīgajai vērtībai.

API izstrāde botiem

Lai izstrādātu API, jums būs nepieciešams hostings, uz kura tas tiks balstīts. Ja jums tāda nav vai neesat programmēšanas eksperts, varat sazināties ar mums, un mēs izstrādāsim API jūsu botam un izvietosim to uz mūsu hostinga. Pats hostings ir bezmaksas, jūs maksāsiet tikai par izstrādi.

Pagaidām nedaudz teorijas.

Bots atbalsta GET un POST pieprasījumus, kas ir galvenie veidi, ko izmanto lielākajā daļā publisko API.

GET ir pieprasījums, kas notiek, noklikšķinot uz saites vai atverot saiti pārlūkprogrammā. Parametri šādā pieprasījumā tiek pārsūtīti URL pieprasījumos.

Pārsūtīto parametru sintakse: pēc url ir jautājuma zīme (?), tad katrs parametrs tiek atdalīts ar & zīmi. Parametrs sastāv no nosaukuma un tā vērtības pēc vienādības zīmes (=). URL piemērs ar parametru:

Šeit var redzēt, ka tiek kopīgots viens parametrs ar nosaukumu “search_query” un tā vērtība ir “queen live aid”. ‘+’ šeit ir atstarpe starp vārdiem; strādājot ar rediģēšanas programmatūru, varat vienkārši atstāt atstarpes – bots tās mainīs pats.

POST ir pieprasījuma veids, kas visbiežāk tiek nosūtīts, aizpildot veidlapu tīmekļa vietnē. Pieprasījums pārsūta parametrus pamattekstā; protams, tos var kopīgot tāpat kā GET, bet tas tiek darīts reti. Parametrs pamattekstā var būt JSON formātā vai kā atslēgas-vērtības pāris. Kā atslēgas-vērtības parametri kopīgo veidlapas, JSON formāts ir tas, ko visbiežāk izmanto API.

Pieprasījuma galvene. Katram pieprasījumam var pievienot galveni/virsrakstu. Tajā visbiežāk tiek ierakstīts kopīgoto datu formāts un piekļuves atslēgas. Parasti mēs atstājam šo cilni tukšu, bet retos gadījumos tajā jāievieto API marķieris vai pieprasījuma veids “Content-type”: “application/json”.

JSON - (JavaScript Object Notation) ir atvērts standarta faila formāts un datu apmaiņas formāts, kas izmanto cilvēkiem lasāmu tekstu, lai glabātu un pārsūtītu datu objektus, kas sastāv no atribūtu-vērtību pāriem un masīviem. Lai strādātu ar API botos, jums jāzina šis formāts, viss ir uz tā balstīts.

Pirms turpināt, izlasiet šādus rakstus:

https://www.json.org/json-en.html
https://developer.mozilla.org/en-US/docs/learn/javascript/objects/json

Un arī mēģiniet izveidot savu JSON failu šajā vietnē:

https://jsoneditoronline.org

Prakse

Bloki un nosacījumi var apstrādāt pieprasījumus. Nosacījumu pieprasījumi tiek izveidoti, lai saprastu vietnē, vai dialogs var sekot noteiktam ceļam vai nē. Pieprasījums šajā gadījumā notiek katru reizi, kad tiek pārbaudīts ceļa nosacījums. Bloku pieprasījumi, gluži pretēji, tiek palaisti tikai tad, kad notiek pāreja uz bloku.

Pirms pieprasījuma izveides jums jāizvēlas tā veids:

POST-data un POST-json atšķiras ar parametru pārsūtīšanas metodi, kā minēts iepriekš (JSON formāts vai kā atslēgas-vērtības pāris). Ja izvēlaties JSON, tad parametrus var pārsūtīt tikai pieprasījumā. Ziņai tiek atvērts papildu lauks: JSON POST parametri. Svarīgi! Parametri jāraksta tikai JSON formātā, bots strādā tikai šādi.

Atbildi no servera var parsēt un saglabāt mainīgajos.

Atbildi var apstrādāt tikai tad, ja tā ir JSON formātā.

Saglabātie mainīgie tiek ierakstīti pēdējā neaizpildītajā iesniegumā; ja iesniegums tiek pārsūtīts caur sarkano bloku, mainīgie tiek anulēti. Tātad, ja jums ir jāsaglabā dati, jums jāpārsūta mainīgie caur dzelteno bloku.

Starp citu, jūs varat redzēt, ko bots ir ierakstījis mainīgajos sadaļā Leads:

Datu pārsūtīšana nevis kā rinda

Pēc noklusējuma mainīgā vērtība tiek iegūta formātā #{} bet pēc tam tā tiek pārsūtīta kā rinda. Lai mainīgais tiktu pārsūtīts kā skaitlis, jums jāizslēdz post-json parametru formāta pārbaude.

Tad varat vienkārši minēt mainīgā nosaukumu, piemēram, {"key": #{variable_name}}, variable_name ir mainīgais, tātad neizmantojot iekavas.

Pēc parametru iestatīšanas ieteicams atkal ieslēgt pārbaudi.