Povezovanje informacijskih sistemov z Intrix API in Webhook

Intrix je sistem, ki s svojo povezljivostjo nudi prilagodljive možnosti povezave s preostalimi spletnimi aplikacijami, spletnimi mesti ter ostalo programsko opremo. V sistem Intrix lahko prenašamo oddana povpraševanja iz obrazca na vaši spletni strani, podatke iz vaše interne poslovne aplikacije, podatke o servisnih in reklamacijskih zahtevkih, in mnogo več. Obenem lahko podatke prenašamo tudi iz aplikacije Intrix.

V okviru sistema Intrix je tako moč pripraviti aplikacijski programski vmesnik (API) ali posamezno spletno točko (Webhook), ki ustreza potrebam posameznega naročnika in zagotavlja enostavno integracijo naročnikovih informacijskih sistemov. To pa privede do izboljšanja učinkovitosti in produktivnosti. Intrix API in Webhook nudita enostavno povezljivost. S slednjo sinhronizacija in prenos podatkov postaneta hitra in preprosta.

Vsak vmesnik za povezovanje spletnih storitev in ostalih sistemov z aplikacijo Intrix pripravimo skladno s potrebami posameznega naročnika. Sprva posamičen naročnik podrobneje predstavi potrebe in definira želen tok podatkov. Torej, ali želi podatke prenašati iz aplikacije Intrix, v aplikacijo Intrix ali pa obojesmerni prenos podatkov. Takrat naročnik definira tudi entitete, ki jih želi vključiti v prenos (npr. podjetja, priložnosti, …). Z naročnikom se nato podrobneje pogovorimo tudi o preostalih podrobnostih povezave in se vzajemno odločimo za pristop in način povezave (Intrix API ali Webhook).

Intrix API

Intrix aplikacijski programski vmesnik je strukturiran na SOAP (Simple Object Access Protocol) modelu spletnih storitev. Le-ta omogoča standardizirano, varno ter robustno komunikacijo med različnimi aplikacijami. S potrjevanjem podatkov zagotavlja, da so preneseni podatki resnični in niso bili spremenjeni med prenosom, podatke med prenosom šifrira in obenem s standardizirano obliko za sporočanje zagotavlja, da so lahko različni sistemi usklajeni pri prenosu in branju podatkov.

Tako Intrix API kot tudi protokol SOAP temeljita na vnosu informacij v XML formatu. Informacije pričakujeta v temeljnem elementu (Envelope), znotraj slednjega pa pričakujeta še elemente glave (Header) ter telesa (Body).

Skladno s potrebami posameznega naročnika oblikujemo specifičen SOAP vmesnik, ki vsebuje po meri pripravljene metode. Ta vmesnik postane del naročnikove Intrix aplikacije in se neposredno sporazumeva le z omenjeno aplikacijo.

Naročniku so za dostop in uporabo vmesnika podeljene posebne pravice. Le-te mora ob pripravi zahtevka, v obliki uporabniškega imena ter gesla, zajeti v glavi (Header) XML, obenem pa v temeljni element (Envelope) navesti tudi način avtentikacije ter povezavo do SOAP vmesnika ciljne Intrix aplikacije.

Uporabniško ime ter geslo, ki je namenjeno dostopu do SOAP vmesnika, se pripravi po meri in ob ureditvi posameznega vmesnika.

Pošiljanje zahtevka in povezljivost na pripravljene metode je povsem preprosta. Telo informacij dopolnimo z nazivom ciljne metode ter za vsako lastnost metode, z vrednostmi. Prvi element, ki se nahaja v telesu XML zahtevka, mora biti poimenovan z nazivom metode. Znotraj elementa metode pa je lastnosti in njihove vrednosti potrebno beležiti v elementu imenovanem parameters. Vsaka lastnost v omenjenem elementu dobi lastno XML značko, ki je imenovana enako kot sama lastnost.

Nekoliko pozornosti je potrebno nameniti še tipom navedenih lastnosti. Element parameters je objektne oblike, oblike samih lastnosti pa bodo definirane v specifikaciji za specifičen, po meri pripravljen vmesnik posamezne Intrix aplikacije.

Ročnemu pisanju zahtevka v XML formatu se, seveda, ni potrebno pretirano posvečati. Opisan primer je namenjen spoznavanju pričakovane vhodne strukture in naknadnemu razhroščevanju, če generiran XML ni enak pričakovanemu. Za dejanske integracije se zanesemo na obstoječe knjižnice.

Primer v jeziku PHP:

Ob pripravi SOAP vmesnika lahko pripravimo tudi Postman kolekcijo, ki olajša prve korake in razhroščevanje urejanja povezave z Intrix API.

Intrix Webhook

Webhook postaja vse bolj popularna izbira za integracijo enostavnejših povezav in funkcionalnosti med sistemi. V bistvu gre za spletno točko (URL), ki prejema HTTP zahtevke in se na zahtevke odziva v skladu z zastavljeno specifikacijo. Webhook je tako namenjen odzivu na dogodek, ki se zgodi v drugem sistemu. Slednji sistem (ob dogodku) namreč pošlje zahtevek na zastavljeno spletno točko, Webhook pa v lastnem sistemu, glede na zahtevek, izvede specificirano programsko kodo.

Webhooki so tako primernejši za integracijo različnih manj kompleksnih storitev, kot so posodabljanje, vnos podatkov (npr. podjetja, kontakta, …) v CRM, samodejnega obveščanja preko elektronske pošte in podobno. Velikokrat se uporabljajo tudi za vnos prejetih povpraševanj iz spletne strani neposredno v aplikacijo Intrix.

Proženje spletne točke se izvede v obliki GET ali POST zahtevka. Oblika je odvisna od posamezne spletne točke in bo navedena v specifikaciji, ki je pripravljena za posameznega naročnika. V obeh primerih pa vmesnik podatke za avtentikacijo pričakuje v obliki GET parametrov.

Vmesnik lahko pričakuje tudi morebitne nadaljnje GET parametre. Tudi ti so odvisni od specifične metode in jih opišemo v specifikaciji za posameznega naročnika. Kadar pa gre za POST zahtevek, mora klicatelj spletne točke podatke pripraviti v dogovorjeni obliki in v telesu zahtevka (Body). Omenjeni so ponavadi v obliki JSON.

Primer telesa zahtevka v obliki JSON: