Meta d-dokumenti jibdew f'sistema oħra

Il-mistoqsija li toħroġ fit-tieni laqgħa: «tintegraw mas-sistema tagħna?». Sa issa t-tweġiba onesta kienet le. Issa t-tweġiba hija din: għandek portal, CRM jew sistema tal-kontabilità fejn in-negozju diġà jeżisti, u DocuTract jista' jaħdem bħala parti minnha.

Is-sitt karatteristika tal-mewġa hija t-triq 'il barra. Token li bih is-sistema tiegħek issejħilna, indirizz li niktbulu waħedna, u deskrizzjoni miftuħa ta' kull ma hemm bejniethom.

Token li ma nistgħux nuruhulek darbtejn

Token jinħoloq fuq l-iskrin Integrazzjonijiet: isem li tagħrfu aktar tard, biex tkun taf liema sistema qed tużah, u lista ta' dak li għandu permess jagħmel. Imbagħad jintwera darba.

Dan mhux nuqqas ta' memorja, huwa kif irid jaħdem prodott li jżomm iċ-ċavetta ta' xi ħadd ieħor. Inżommu biss hash: li nuru t-token it-tieni darba huwa xi ħaġa li lanqas aħna ma nistgħu nagħmlu, li jfisser li ma jistax jinsteraq mingħandna. Il-lista żżomm l-ewwel karattri, il-permessi u d-data li fiha ntuża l-aħħar, biex ikun jidher liema token huwa ħaj u jekk xi ħadd għadux qed jużah.

Irrevoka jitfih minnufih. Ir-rekord tiegħu jibqa': li eżista u meta waqaf jaħdem huwa parti mill-istorja tal-ispazju tax-xogħol, mhux skart.

Il-permessi jiġu ċċekkjati fuq kull indirizz separatament. Token li għandu permess biss jaqra l-mudelli jieħu «the documents:write scope is missing» ċar meta jipprova joħloq dokument, mhux «not found» vojt. Nassumu li hemm persuna ħajja qed tqabbad l-integrazzjoni, u tweġiba li ma tispjega xejn tiswielhom serata.

X'tista' tagħmel l-API

Daqs kemm tista' tagħmel fuq l-iskrin, biss mingħajr l-iskrin: tiftaħ każ u ttella' skans fih, toħloq dokument minn mudell bil-valuri diġà mimlija, tistaqsi f'liema stadju wasal, tieħu kull valur flimkien mal-iskan li minnu nqara kull wieħed, u tieħu link qasir il-ħajja għall-fajl lest.

Dik l-aħħar parti hija dak li jagħmel din l-integrazzjoni differenti mill-oħrajn. Is-sistema tiegħek tirċievi mhux biss fajl mimli imma kull valur bl-oriġini tiegħu: l-iskan, il-qasam, kemm kienet kunfidenti l-qari. L-istess sors li persuna tara fuq l-iskrin tar-reviżjoni huwa disponibbli għall-kodiċi.

Id-deskrizzjoni ta' kull indirizz u qasam tiġi ġġenerata mill-kodiċi nnifsu u ppubblikata b'mod miftuħ, mingħajr token: /api/v1/openapi.json. Dokumentazzjoni li trid titlobha l-ewwel hija dokumentazzjoni li ħadd ma jaqra.

Webhooks u log onest

M'għandekx għalfejn tistaqsina jekk dokument huwiex lest. Agħtina indirizz u immarka l-avvenimenti: dokument lest, dokument falla, każ lest, instab nuqqas ta' qbil, klijent bagħat fajl.

Kull talba hija ffirmata, u s-sigriet li jivverifika l-firma jintwera darba, bħat-token. Jekk is-server tiegħek wieġeb xi ħaġa oħra, jew ma wieġeb xejn, nerġgħu nippruvaw: wara minuta, wara ħamsa, wara nofs siegħa, wara sagħtejn u wara għaxra. Imbagħad nieqfu, għax integrazzjoni li ħadd mhu qed iżomm m'għandhiex tonfoq ir-riżorsi ta' xi ħadd għal dejjem.

U mbagħad il-parti li għaliha nkiteb dan kollu. Meta n-naħa l-oħra tgħid «is-sistema tagħna ma rċeviet xejn», it-tweġiba tinsab fuq l-iskrin: l-avveniment, il-ħin, kemm-il tentattiv, liema kodiċi tat-tweġiba ġie lura u l-bidu tal-body tat-tweġiba. Jidher li wieġeb 500 ħames darbiet. Din mhix għajnuna għad-debugging għalina, hija tweġiba għall-inġinier tiegħek.

Ħdejha, żewġ buttuni għas-siegħa meta integrazzjoni tkun għadha qed tiġi ssettjata. Ibgħat test jibgħat talba ta' prova issa stess, mingħajr ma jistenna avveniment reali, biex riċevitur ikun jista' jiġi ċċekkjat qabel ma jgħaddi xogħol minnu. Erġa' pprova, ħdejn kunsinna li falliet, jagħmel tentattiv ieħor minnufih u ma jirresettjax l-istorja: l-erba' tentattivi falluti jibqgħu fir-rekord, għax dik hija l-verità dwar kemm swiet din in-notifika.

Il-limiti li npoġġu fuqna nfusna

Webhook imur biss għal https u biss għal indirizz pubbliku: indirizz ġewwa netwerk privat jiġi rrifjutat kemm meta jiġi ssejvjat kif ukoll qabel kull tentattiv, għax hostname li lbieraħ kien jipponta 'l barra jista' jipponta 'l ġewwa llum. Il-limitu tar-rata jgħodd għal kull token aktar milli għal kull indirizz, biex ġar fuq l-istess server ma jonfoqx il-kwota tiegħek, u min jaqbiżha jieħu «erġa' ġib wara dawn is-sekondi» onest.

L-API u l-webhooks huma parti mill-pjan Team. Jekk ispazju tax-xogħol jgħaddi għal pjan ieħor, dak li diġà nħoloq jibqa' viżibbli u jista' jiġi rrevokat: ċwievet li ħadd ma jista' jilħaq huma agħar minn karatteristika bi ħlas.

Dak li mhux f'din il-ħarġa

Il-brief għal din il-fażi ddeskriva żewġ partijiet oħra: l-esportazzjoni ta' dokument lest lejn Google Drive, OneDrive jew Dropbox, u l-bgħit tiegħu għall-firma permezz ta' DocuSign jew Dropbox Sign. It-tnejn jeħtieġu kredenzjali minn dawk il-fornituri, li bħalissa m'għandniex, u l-kitba ta' integrazzjoni li ma tista' tiġi ttestjata mkien tfisser li tgħaddi kodiċi mhux miktub bħala lest. Jibqgħu fil-pjan bħala ħarġiet għalihom.

X'jmiss

Is-seba' u l-aħħar karatteristika tal-mewġa hija l-ġenerazzjoni f'lott: lista ta' ħamsin ringiela jew arkivju ta' skans minflok ħamsin mili identiku bl-idejn, bi progress viżibbli u l-għażla li tirrepeti biss dawk li ma ħadmux.

Il-lista sħiħa tinsab f'dak li qed nibnu wara, u l-istruzzjonijiet pass pass għall-integrazzjonijiet jinsabu fiċ-ċentru tal-għajnuna.