Pielāgotie elementi: API

API saskarne ir forma, kuras aizpildītās vērtības Skava nosūta kā JSON uz jums norādīto adresi (jūsu backendu). Tādējādi var droši savienot Skavu ar savām sistēmām.

Iestatiet API saskarni

Saskarne sastāv no ievades laukiem (tie veido JSON), mērķa adreses un autentifikācijas.

1. Lauku izveide: Katram laukam tiek piešķirts JSON atslēga. Labajā pusē redzat JSON priekšskatījumu reāllaikā, kas tiek nosūtīts jūsu backend sistēmai tieši šādā formātā.
2. Adrese (URL): jūsu backend sistēmas https:// adrese. Atļautas ir tikai HTTPS un publiski pieejamas adreses (skatiet sadaļu Drošība zemāk).
3. Metode: POST (noklusējums), PUT, PATCH vai GET. Izmantojot GET, vērtības tiek pievienotas kā vaicājuma parametri, nevis nosūtītas ķermenī.
4. Autentifikācija: Iestatiet galvenes nosaukumu (piem., Authorization) un vērtības prefiksu (piem., Bearer ), pēc tam saglabājiet tokeni. Pēc izvēles iestatiet derīguma termiņu.
5. Atbilmes lauki (neobligāti): Definējiet ceļu, lai noteiktu, kuras vērtības no backend atbildes jāattēlo: piem., order.id vai items[0].sku.
6. Pārbaudiet ar Ping un Test Request, pēc tam Release.

Uzglabājiet tokeni droši

Tokens tiek uzglabāts šifrētā formā un nekad netiek atgriezts klientiem: lietojumprogramma rāda tikai faktu, ka tokens ir iestatīts, un tā derīguma termiņu. Sūtot, Skava servera pusē pievieno to iestatītajam galvenejam. Ja iestatāt derīguma termiņu, Skava pēc termiņa beigām noraida izsaukumu un lūdz atjaunot tokeni.

Testēšana: Ping un Test Request

• Ping: viegla pieejamības pārbaude. Tas pārbauda tikai to, vai jūsu adrese atbild, un procesā nesūta tokeni vai formu datus. Rāda pieejamību, statusu un atbildes laiku. Ideāls kā pirmais solis.
• Testa pieprasījums: īstais pārbaudes skats: nosūta parauga datus, ieskaitot tokeni, uz jūsu adresi un parāda gan pilnu atbildi, gan izvilktos atbildes laukus.

Kā administrators, jūs varat palaikt abus, kamēr joprojām esat melnraksta režīmā, lai pārliecinātos par integrāciju pirms izdošanas.

Melnraksts un publicēšana

Katrs interfeiss sākas kā melnraksts un to var brīvi rediģēt. Kad viss ir gatavs, to publicē ar Publicēt.

Drošība

Kā komanda izmanto publicētu interfeisu

Tiklīdz interfeiss ir publicēts, visi uzņēmuma dalībnieki var to aktivizēt tieši no tērzēšanas, bez redaktora. Nav kopīgas ievades un nav starpposma dialoga: katrs publicēts elements atrodas plus izvēlnē ar savu nosaukumu un piedāvājošā uzņēmuma logotipu.

1. Tērzēšanā nospiediet Plus apakšā un izvēlieties vēlamo elementu, piemēram, Materiālu pasūtījums.
2. Aizpildiet formu un nospiediet Sūtīt.
3. Rezultāts parādās kā karte tērzēšanā, kas ir redzama visiem tērzēšanas dalībniekiem.

Ļaujiet mākslīgajam prātam izveidot elementu

Kā uzņēmuma administrators jums nav jāizmanto redaktors pašam. Pastādiet Skava asistentam tērzējumā, piemēram, “izveido man pasūtījuma formu katalogam ar daudzumu un piegādes adresi”. Tas no tā izveido melnorakstu, vēlāk var mainīt laukus pa vienam, un tas zina jūsu augšupielādēto rakstu katalogu: pasūtījumiem tas piedāvā produktu izvēlni, nevis teksta lauku raksta numuram.

Tas var iestatīt arī: galapunktu un metodi, kā arī auditoriju (“tikai uzņēmuma locekļi” vai “arī ārpusē esošie tajā pašā tērzējumā”). Par auditoriju tas vispirms jautā, nevis vienkārši to iestatī, jo tas nosaka, kas var palaist kaut ko no ārpuses.

Ko tas skaidri neaizskaras: piekļuves tokeni. Tas nekad neprasī un nekad neacceptē, jo tērzējuma ziņas tiek saglabātas. Jūs to ievadāt pats redaktorā, citādi neviens izsaukums netiek nosūtīts. Un tas nevar publicēt: pēdējais solis paliek jums, lai nekas netiktu redzams klientiem nepārbaudīts.

Kas var to palaist

Lielākā daļa no “Galapunkts” cilnes nosaka, kas var izmantot elementu. Noklusējums ir jūsu uzņēmuma locekļi. Otrā iestatījuma opcija atver to ārzemniekiem, bet tikai tērzējumā, kur ir klāt kāds no jūsu uzņēmuma: tieši tas gadījums, kam tas ir paredzēts, klients, kas pasūta no jums. Kad jūsu uzņēmums pamet tērzējumu, tiesības beidzas pašas no sevis.

Produkti no jūsu kataloga

Kad esat augšupielādējis savu preču katalogu, būvniekam tiek piedāvāts produktu atlasītāja bloks. Nav jāuztur kādas opcijas: saraksts ir jūsu katalogs. Pasūtītājs to meklē, redz attēlu, nosaukumu un artikula numuru, un jūsu backend saņem artikula numuru. Skava noraida numuru, kas nav jūsu katalogā. Dabai blakus novietojiet parastu skaitļa lauku.

Definējiet karti pats

Jūsu backend nosaka, ko karte saka. Skava pārbauda tikai formu, izmēru un drošību, nekad nozīmi: tā nezina ne pasūtījuma stāvokļus, ne lauku nosaukumus. Lai to izdarītu, atbildiet ar card objektu:

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

• v ir jābūt veselajam skaitlim 1. Bez tā atbilde netiek uzskatīta par karti, un tiek piemērota elementā iestatītā atbilžu kartēšana.
• state ir tikai krāsa un ikona: ok, pending, warn vai error. Viss, kas nes nozīmi, iet status_text kā brīvs teksts.
• fields ir saraksts ar etiķetēm un vērtībām, maksimāli 20 ieraksti. Pārāk garas vērtības tiek saīsinātas, nevis noraidītas, lai pasūtījums neizkļūtu dēļ kādas detaļas.

Lietotāja ievades pieder serverim: tās paliek neskartas neatkarīgi no tā, ko nosūta jūsu aizmugures daļa. Tās ir čata ieraksts par to, kas faktiski tika iesniegts.

Statusa ziņošana vēlāk

Kad elements tiek izpildīts, Skava nosūta divas papildu vērtības: callback_url un callback_token. Tur vēlāk ziņojiet par jaunu stāvokli, un čatā, arī telefonā, parādās jauna karte, kamēr kāds to skatās. Iepriekšējā karte paliek, lai būtu skaidrs, kurš stāvoklis tika ziņots. Nosūtiet to pašu card objektu kā augstāk, ar POST un galviņu Authorization: Bearer <callback_token>. Trīs neobligās vērtības iet blakus kartei:

• seq: jūsu pašu skaitītājs. Ziņojums ar mazāku vai vienādu vērtību tiek noraidīts, tāpēc divi ziņojumi nevar apdzīt viens otru.
• final: noslēdz mijiedarbību. Žetons kļūst nederīgs un karte ir galīgā.
• notify: iestatiet uz false, lai karti publicētu klusumā, bez nolasīto skaitītāja un bez paziņojuma. Piemērots starpposmiem, kas nevajadzētu pamodināt nevienu. Bez šī parametra karte ir pilnīgi parasta ziņa.

Vienā mijiedarbībā var publicēt ne vairāk kā 50 kartes. Divreiz tas pats ziņojums nerada otro karti.

Skava atbild ar 200 un hints sarakstu, ja kaut kas tika saīsināts vai izlaists, un ar 422, ja karte nebija izmantojama. Mijiedarbība pieņem ziņojumus 90 dienas.

Kartes nosūta Skava sistēmas sūtītājs, nevis persona, kas izpildīja elementu, un nevis jūsu uzņēmuma konts. Kurš sistēms raksta, norādīts kartes nosaukumā.

Pilns piemērs kopēšanai atrodas repozitorijā example_order_server/ un darbojas api.skava.io.

Saistītie

Vai vēlaties izveidot aizpildāmu dokumenta veidni? Skatiet Pielāgotie elementi: Dokumenti.

Biežāk uzdotie jautājumi