API je kratica za aplikacijsko programsko sučelje. Svaki softver s određenom funkcijom naziva se aplikacija kada se govori o API-jima. Možete usporediti API sučelje sa ugovorom o usluzi između dva programa koji specificiraju zahtjeve i odgovore. Ako ste novi u API-jima, preporučujemo da pogledate naš Vodič za API-je za početnike i Pregled REST API-ja blog prije čitanja ovog.

API-ji REST omogućuju vam pristup CRM podacima putem HTTP/HTTPS protokola. Možete izvoditi radnje kao što su stvaranje, ažuriranje, dohvaćanje ili brisanje operacija na bilo kojoj informaciji CRM zapisa. Također će vam omogućiti pohranu podataka o konfiguraciji specifičnih za proširenje i korisnika ili povezivanje s vanjskim aplikacijama pomoću pohranjenih podataka specifičnih za proširenje. Svim tim podacima može se pristupiti osnovnom autorizacijom, odnosno korisničkim imenom i pristupnim ključem.

Stvaranje REST API-ja

Slijedi pet općih koraka koje možete koristiti za izgradnju bilo kojeg API-ja:

Planirajte API: Smjernice za dizajniranje vašeg API-ja daju specifikacije API-ja kao što je OpenAPI. Poželjno je unaprijed razmotriti različite slučajeve upotrebe i osigurati da je API usklađen s trenutnim standardima razvoja API-ja.
Izgradite API: Dizajneri API-ja stvaraju prototipove novih API-ja uz male izmjene postojećih API-ja. Programeri mogu prilagoditi prototip internim zahtjevima nakon što prođe testiranje.
Testirajte API: Slično testiranju softvera, testiranje API-ja potrebno je za zaštitu od pogrešaka i nedostataka. Testirajte snagu API-ja protiv mrežnih napada pomoću alata za testiranje API-ja.
Dokumentirajte API: Iako su API-ji jasni sami po sebi, dokumentacija može lakše pomoći korisnicima. U servisno orijentiranoj arhitekturi češće se koriste dobro dokumentirani API-ji s različitim funkcijama i slučajevima korištenja. Napišite dokument za pomoć kako biste dali upute i pomogli drugima da izgrade svoje API-je.
Tržite API: Postoje mrežna tržišta na kojima programeri mogu kupovati i prodavati API-je drugima, baš kao što postoje za maloprodajnu robu na eBayu, Amazonu i Flipkartu. Možete zaraditi novac od svog API-ja tako da ga navedete.

Ovaj blog će vas naučiti kako izraditi prilagođenu REST API naredbu koristeći Vtigerov API Designer. Pa krenimo.

Što je API dizajner?

API Designer alat je ili programeri aplikacija mogu koristiti za izradu prilagođenih API-ja web usluga. Možete definirati svoje prilagođene krajnje točke usluge i parametre upita. Ovi API-ji se mogu koristiti za interakciju s CRM podacima, integraciju s vanjskim aplikacijama i također izlaganje ovih podataka VTAP Javascript API-jima koji se koriste unutar prilagođenih stranica ili widgeta u Vtiger UI.

Možete izraditi API-je koristeći Vtiger Application Design Language (VADL), koji se labavo temelji na XML sintaksi. VADL omogućuje administratorima ili programerima bez programerskih vještina visoke razine da jednostavno definiraju API-je, ali s osnovnim razumijevanjem programiranja, brzo stvarate učinkovite API-je.

REST API-ji slijede standardni REST API protokol, a njihove krajnje točke možete definirati na sljedeći način:

https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

Za REST API podržane su sljedeće metode HTTP zahtjeva:

GET
POST
PUT
DELETE

Da vidimo kako možete koristiti VTAP za izradu prilagođenog REST API-ja.

Korisnici Vtiger CRM-a mogu izgraditi REST API-je koji će povezati CRM s drugim aplikacijama trećih strana ili izgraditi nove koji će proširiti funkcionalnost CRM-a. Evo primjera:

Kreirajmo REST API koji može pristup podacima iz određena modul koristeći VTAP.

Slijedi primjer API koji dohvaća podatke iz CRM modula tzv Organizacije za prikaz prvih pet organizacija s najvećim godišnjim prihodom s nazivom API-ja kao vrhunske_organizacije. Možete izabrati drugo ime kako bi ostalo jedinstveno.

Prije nego što počnemo, razumijmo XML i VDAL komponente koje će se koristiti za definiranje radnji gore navedenog API primjera.

Sljedeća tablica opisuje XML i VDAL komponente koje će se koristiti za definiranje prilagođenog REST API-ja za pristup i prikaz CRM podataka:

XML i VDAL komponenta	Akcijski
api metoda=”dobiti”	Definiranje metode HTTP zahtjeva
odaberite modul=”Računi”	Definirajte modul za dohvaćanje podataka iz korištenja select
zapis naziv polja=”accountname”>	Definirajte polja u zapisu za dohvaćanje podataka iz upotrebe zapis
vrsta naziv polja=”godišnji_prihod” red=”silazni” /polje /vrsta	Definirajte uvjete za korištenje ishoda tablice vrsta
limit max=”5″ page=”@page” /limit	Definirajte broj detalja zapisa koji će se prikazati pomoću ograničiti
/Izaberi /api	Završite zatvaranjem svih otvorenih oznaka

bilješke da sve XML i VDAL komponente u gornjoj tablici moraju biti priložene oznakama (<>).

Slijedite ove korake za izgradnju REST API-ja o kojem smo govorili gore:

Prijavite se na svoj Vtiger CRM račun.
kliknite Glavni izbornik.
Kliknite Platforma.
odabrati Dizajner API-ja.
Kliknite +Dodaj API.

Kliknite stvoriti pored REST API-ja. Otvara se prozor Dodaj REST API.

Dodajte REST API: Unesite ili odaberite podatke za sljedeće:

Moduli: Odaberite CRM modul iz kojeg treba pristupiti podacima.
Ime: Unesite jedinstveni identifikator za API.
Status: Pritisnite potvrdni okvir za aktivaciju API-ja.

Kliknite UŠTEDI.

Nakon što dodate API, vidjet ćete ugrađeni IDE gdje ćete koristiti VADL za definiranje API-ja i XML čvorova za dohvaćanje CRM podataka. Pogledajte gornju tablicu da biste razumjeli XML i VADL komponente.

Kliknite Spremi i objavi za objavljivanje izgrađenog API-ja.

Gore navedenom REST API-ju možete pristupiti i testirati ga iz bilo koje vanjske aplikacije koristeći sljedeći URL.

https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

bilješke da je gornji URL primjer i morat ćete definirati krajnju točku prema svojoj CRM instanci.

Jeste li znali?
Gore navedeni podaci mogu se koristiti za prikaz kao popis na prilagođenoj stranici ili se mogu koristiti za trakasti grafikon i druge dinamičke rezultate pomoću komponenti javascripta za definiranje vaših API-ja. Svim prilagođenim REST API-jima ugrađenim u API Designer također se može pristupiti pomoću VTAP Javascript API -ji.

Da biste saznali više o izradi prilagođenih API-ja i VTAP-a, pogledajte VTAP dokumentacija.