Kui dokumendid saavad alguse teises süsteemis

Küsimus, mis kerkib üles teisel kohtumisel: „kas te integreerute meie süsteemiga?“. Seni oli aus vastus ei. Nüüd on vastus selline: sul on portaal, CRM või raamatupidamissüsteem, kus tehing juba olemas on, ja DocuTract saab töötada selle osana.

Laine kuues funktsioon on väljapääs. Token, millega sinu süsteem meid kutsub, aadress, millele kirjutame omal algatusel, ja avalik kirjeldus kõigest, mis on vahepeal.

Token, mida me ei saa sulle kaks korda näidata

Token luuakse vaates Integratsioonid: nimi, mille hiljem ära tunned, et teaksid, milline süsteem seda kasutab, ja loend sellest, mida sellel lubatakse teha. Seejärel näidatakse seda üks kord.

See pole unustamine, vaid see, kuidas peab töötama toode, mis hoiab kellegi teise võtit. Hoiame ainult räsi: tokeni teist korda näitamine on midagi, mida isegi meie ei suuda, mis tähendab, et seda ei saa meilt varastada. Loend säilitab esimesed märgid, õigused ja viimase kasutamise kuupäeva, nii et on näha, milline token on elus ja kas keegi seda veel kasutab.

Tühista lülitab selle kohe välja. Kirje sellest jääb alles: see, et see oli olemas ja millal see töötamast lakkas, on osa tööruumi ajaloost, mitte prügi.

Õigusi kontrollitakse iga aadressi puhul eraldi. Token, millel on lubatud ainult malle lugeda, saab dokumendi loomise katsel selge vastuse „documents:write õigus puudub“, mitte tühja „ei leitud“. Eeldame, et integratsiooni ühendab päris inimene, ja vastus, mis midagi ei selgita, maksab talle terve õhtu.

Mida API teha oskab

Sama palju kui ekraanil, ainult ilma ekraanita: avada juhtum ja laadida sinna skaneeringuid, luua malli põhjal dokument juba täidetud väärtustega, küsida, millisesse etappi see on jõudnud, võtta kõik väärtused koos skaneeringuga, millest igaüks loeti, ja saada valmis failile lühiajaline link.

See viimane osa teebki selle integratsiooni teistest erinevaks. Sinu süsteem ei saa lihtsalt täidetud faili, vaid iga väärtuse koos selle päritoluga: skaneering, väli, kui kindel lugemine oli. Sama allikas, mida inimene näeb kontrollimise vaates, on kättesaadav koodile.

Iga aadressi ja välja kirjeldus genereeritakse koodist endast ja avaldatakse avalikult, ilma tokenita: /api/v1/openapi.json. Dokumentatsioon, mida pead kõigepealt küsima, on dokumentatsioon, mida keegi ei loe.

Veebihaagid ja aus logi

Sa ei pea meilt küsima, kas dokument on valmis. Anna meile aadress ja märgi sündmused: dokument valmis, dokument ebaõnnestus, juhtum valmis, leiti lahknevus, klient saatis faili.

Iga päring on allkirjastatud ja saladust, millega allkirja kontrollitakse, näidatakse üks kord, nagu tokenitki. Kui sinu server vastas millegi muuga või ei vastanud üldse, proovime uuesti: minuti pärast, viie minuti pärast, poole tunni pärast, kahe tunni pärast ja kümne tunni pärast. Siis me lõpetame, sest integratsioon, mida keegi ei hoolda, ei peaks kellegi ressursse igavesti kulutama.

Ja siis osa, mille jaoks kõik see kirjutati. Kui teine pool ütleb „meie süsteem ei saanud midagi“, on vastus ekraanil: sündmus, aeg, mitu katset, milline vastuskood tuli ja vastuse sisu algus. On näha, et see vastas viis korda koodiga 500. See pole meie silumisabivahend, vaid vastus sinu insenerile.

Selle kõrval kaks nuppu tunniks, mil integratsiooni alles seadistatakse. Saada test postitab proovipäringu kohe, ootamata päris sündmust, nii et vastuvõtjat saab kontrollida enne, kui sellest läbi läheb päris töö. Proovi uuesti ebaõnnestunud kohaletoimetamise kõrval teeb veel ühe katse kohe ega lähtesta ajalugu: neli ebaõnnestunud katset jäävad kirja, sest see on tõde selle kohta, mida see teavitus maksma läks.

Piirangud, mille oleme endale seadnud

Veebihaak läheb ainult https-aadressile ja ainult avalikule aadressile: privaatvõrgu sisene aadress lükatakse tagasi nii salvestamisel kui ka enne iga katset, sest hostinimi, mis eile osutas väljapoole, võib täna osutada sissepoole. Päringute sageduse piirang arvestab tokeni, mitte aadressi kaupa, nii et naaber samas serveris ei kuluta sinu limiiti, ja selle ületamisel saab ausa vastuse „tule tagasi nii mitme sekundi pärast“.

API ja veebihaagid kuuluvad Team paketti. Kui tööruum läheb üle teisele paketile, jääb juba loodu nähtavaks ja seda saab tühistada: võtmed, milleni keegi ei ulatu, on halvemad kui tasuline funktsioon.

Mida selles väljalaskes pole

Selle etapi lähteülesanne kirjeldas veel kaht osa: valmis dokumendi eksportimist Google Drive'i, OneDrive'i või Dropboxi ning selle allkirjastamiseks saatmist DocuSigni või Dropbox Signi kaudu. Mõlemad vajavad nendelt pakkujatelt mandaate, mida meil praegu pole, ja kirjutada integratsiooni, mida ei saa kuskil testida, tähendab anda kirjutamata koodi valmis koodina välja. Need jäävad plaani omaette väljalasetena.

Mis edasi

Laine seitsmes ja viimane funktsioon on hulgigenereerimine: viiekümnerealine loend või skaneeringute arhiiv viiekümne ühesuguse käsitsi täitmise asemel, nähtava edenemise ja võimalusega korrata ainult neid, mis ei õnnestunud.

Täielik loend on postituses mida me järgmiseks ehitame ning integratsioonide samm-sammuline juhend on abikeskuses.