Прилагодни елементи: API

API интерфејс је образац чије попуњене вредности Skava шаље као JSON на адресу коју одредите (ваш бекенд). Овим путем можете безбедно повезати Skava са вашим системима.

Подесите API интерфејс

Интерфејс се састоји од поља за унос (она формирају JSON), циљне адресе и аутентификације.

1. Креирање поља: Свако поље добија JSON кључ. С десне стране видите уживо JSON преглед, који се шаље вашем бекенду управо на овај начин.
2. Адреса (URL): https:// адреса вашег бекенда. Допуштене су само HTTPS и јавно доступне адресе (види Безбедност испод).
3. Метод: POST (подразумевано), PUT, PATCH или GET. Код GET вредности се додају као параметри упита уместо да се шаљу у телу захтева.
4. Аутентификација: Поставите назив заглавља (нпр. Authorization) и префикс вредности (нпр. Bearer ), а затим сачувајте токен. Опционо поставите датум истека.
5. Поља одговора (опционо): Дефинишите путем који вредности из одговора бекенда треба приказати: нпр. order.id или items[0].sku.
6. Proverite pomoću Ping i Test Request, zatim Release.

Безбедно чување токена

Токен се чува шифровано и никада се не враћа клијентима: апликација приказује само да ли је токен постављен и када истиче. При слању, Skava га додаје на страни сервера у конфигурисани заглавље. Ако поставите датум истека, Skava одбија позив након истека и тражи да обновите токен.

Тестирање: Ping и тестни захтев

• Ping : provera dostupnosti. Proverava samo da li vaša adresa odgovara, a pritom ne šalje token niti podatke iz obrasca. Prikazuje dostupnost, status i vreme odziva. Idealno kao prvi korak.
• Testni zahtev : prava probna vožnja: šalje uzorke podataka uključujući token na vašu adresu i prikazuje vam kompletan odgovor kao i izdvojena polja iz odgovora.

Kao administrator, možete pokrenuti oba dok ste još u režinu nacrta kako biste proverili integraciju pre objavljivanja.

Nacrt i objavljivanje

Svako sučelje počinje kao nacrt i može se slobodno uređivati. Kada je sve spremno, objavite ga putem opcije Objavi.

Sigurnost

Kako tim koristi objavljeni interfejs

Kada se interfejs objavi, svi članovi firme mogu ga pokrenuti direktno iz chata: nije potreban editor. Tok je isti kao sa šablonima dokumenata: izaberite, popunite, pošaljite.

1. U chatu dodirnite Plus na dnu i izaberite Prilagođeni element.
2. Izaberite željeni šablon ili interfejs sa liste.
3. Popunite formular i Pošaljite.
4. Rezultat se prikazuje kao kartica u ćaskanju: vidljiva je svima u ćaskanju.

Нека вештачка интелигенција изгради елемент

Kao administrator firme ne morate sami koristiti uređivač. Recite Skava asistentu u četu, na primer „napravi mi obrazac za porudžbinu za moj katalog sa količinom i adresom isporuke". On na osnovu toga kreira nacrt, kasnije možete menjati polja jedno po jedno, a on poznaje vaš učitani katalog artikala: za porudžbine predlaže izbornik proizvoda umesto tekstualnog polja za broj artikla.

Šta još može podesiti: endpoint i metodu kao i publiku („samo članovi firme" ili „takođe i spoljni učesnici u istom četu"). Za publiku prvo pita umesto da odmah podesi, jer to određuje ko može pokrenuti nešto iz spolja.

Šta eksplicitno ne dira: token za pristup. Nikada ne traži ni ne prihvata takav token, jer se poruke u četu čuvaju. Vi ga unosite sami u uređivaču, inače se ne šalje nijedan poziv. I ne može da objavi: poslednji korak ostaje na vama, tako da ništa ne postaje vidljivo klijentima bez vaše provere.

Ko ga može pokrenuti

Kartica „Endpoint" govori ko može koristiti element. Podrazumevano su to članovi vaše firme. Druga podešavanja otvara ga i za spoljne učesnike, ali samo u četu gde je prisutan i neko iz vaše firme: baš onaj slučaj za koji je namenjen, kada klijent naručuje od vas. Kada vaša firma napusti čet, dozvola se automatski gasi.

Proizvodi iz vašeg sopstvenog kataloga

Kada učitate katalog artikala, izgrađivač nudi blok izabirača proizvoda. Ne postoje opcije za održavanje: lista je vaš katalog. Osoba koja naručuje pretražuje je, vidi sliku, naziv i broj artikla, a vaš backend prima broj artikla. Skava odbacuje broj koji nije u vašem katalogu. Za količinu, pored njega postavite obično polje za broj.

Definišite karticu sami

Vaš backend odlučuje šta kartica kaže. Skava proverava samo oblik, veličinu i bezbednost, nikada značenje: ne poznaje ni stanja narudžbine ni imena polja. Da biste to uradili, odgovorite objektom card:

{"card": {"v": 1, "title": "Order 10001", "state": "pending", "status_text": "Being picked", "fields": [{"label": "Tracking number", "value": "DPD123456789"}]}}

• v mora biti ceo broj 1. Bez njega odgovor se ne računa kao kartica i primenjuje se mapiranje odgovora konfigurisano u elementu.
• state je samo boja i ikonica: ok, pending, warn ili error. Sve što nosi značenje ide u status_text kao slobodan tekst.
• fields je lista oznaka i vrednosti, najviše 20 stavki. Preduge vrednosti se skraćuju umesto da se odbace, pa narudžbina nikada ne uspeva zbog detalja.

Unosi korisnika pripadaju serveru: ostaju nepromenjeni bez obzira na to šta vaš backend pošalje. To je zapis u četu o tome šta je zapravo podneto.

Izveštavanje o statusu kasnije

Kada se element izvrši, Skava šalje dve dodatne vrednosti: callback_url i callback_token. Kasnije prijavite novo stanje na toj adresi i nova kartica će se pojaviti u četu, i na telefonu, dok neko gleda. Prethodna ostaje, pa je čitljivo koje je stanje prijavljeno. Pošaljite isti objekat card kao gore, putem POST sa zaglavljem Authorization: Bearer <callback_token>. Pored kartice idu tri opciona vrednosti:

• seq: vaš sopstveni broj. Izveštaj sa manjom ili jednakom vrednošću se odbacuje, tako da dva izveštaja ne mogu da se pretiču.
• final: završava interakciju. Token postaje nevažeći, a kartica je završena.
• notify: postavite na false da se kartica objavi tiho, bez broja nepročitanih poruka i bez obaveštenja. Za međukorake koji ne bi trebalo da probude nikoga. Bez toga, kartica je potpuno normalna poruka.

Interakcija može objaviti najviše 50 kartica. Isti izveštaj dva puta ne proizvodi drugu karticu.

Skava odgovara sa 200 i listom hints ako je nešto skraćeno ili izbačeno, i sa 422 ako je kartica bila neupotrebljiva. Interakcija prihvata izveštaje tokom 90 dana.

Kartice objavljuje sistemski pošiljalac Skave, a ne osoba koja je pokrenula element niti nalog vaše firme. U naslovu kartice navedeno je čiji je sistem autor.

Potpuni primer za kopiranje nalazi se u repozitorijumu pod example_order_server/ i radi na api.skava.io.

Povezano

Da li želite da kreirate ispunjivi predložak dokumenta? Pogledajte Prilagođeni elementi: Dokumenti.

Česta pitanja