API je skratka pre Application Programming Interface. Akýkoľvek softvér so špecifickou funkciou sa pri diskusii o API označuje ako aplikácia. Rozhranie API môžete porovnať so zmluvou o poskytovaní služieb medzi dvoma programami, ktoré špecifikujú požiadavky a odpovede. Ak ste novým rozhraním API, odporúčame vám pozrieť si naše Sprievodca rozhraním API pre začiatočníkov a Prehľad REST API blog pred čítaním tohto.
REST API umožňujú prístup k údajom CRM prostredníctvom protokolu HTTP/HTTPS. Môžete vykonávať akcie, ako je vytváranie, aktualizácia, získavanie alebo mazanie operácií s akýmikoľvek informáciami o zázname CRM. Umožní vám tiež ukladať konfiguračné údaje špecifické pre rozšírenie a používateľa alebo sa pripojiť k externým aplikáciám pomocou uložených údajov špecifických pre rozšírenie. Ku všetkým týmto údajom je možné pristupovať pomocou základnej autorizácie, teda pomocou užívateľského mena a prístupového kľúča.
Vytvorenie REST API
Nasleduje päť všeobecných krokov, ktoré môžete použiť na vytvorenie ľubovoľného rozhrania API:
- Naplánujte si API: Pokyny na navrhovanie rozhrania API poskytujú špecifikácie rozhrania API, ako je OpenAPI. Je lepšie vopred zvážiť rôzne prípady použitia a zabezpečiť, aby API vyhovovalo súčasným štandardom vývoja API.
- Zostavte API: Dizajnéri API vytvárajú prototypy nových rozhraní API s malými úpravami existujúcich rozhraní API. Vývojári môžu po testovaní prototyp prispôsobiť interným požiadavkám.
- Otestujte API: Podobne ako pri testovaní softvéru je testovanie API nevyhnutné na ochranu pred chybami a nedostatkami. Testujte API na silu proti online útokom pomocou nástrojov na testovanie API.
- Zdokumentujte API: Aj keď sú rozhrania API samovysvetľujúce, dokumentácia môže používateľom pomôcť jednoduchšie. V architektúre orientovanej na služby sa častejšie používajú dobre zdokumentované API s rôznymi funkciami a prípadmi použitia. Napíšte dokument pomocníka, ktorý poskytne smer a pomôže ostatným vytvoriť ich rozhrania API.
- Predaj API: Existujú online trhoviská, kde môžu vývojári nakupovať a predávať API ostatným, rovnako ako v prípade maloobchodného tovaru na eBay, Amazon a Flipkart. Môžete zarábať peniaze z vášho API jeho uvedením.
Tento blog vás naučí, ako vytvoriť vlastný príkaz REST API pomocou nástroja Vtiger API Designer. Tak poďme na to.
Čo je to API Designer?
API Designer je nástroj alebo vývojári aplikácií, ktoré môžu použiť na vytváranie vlastných rozhraní API webových služieb. Môžete definovať vlastné koncové body služby a parametre dotazu. Tieto rozhrania API je možné použiť na interakciu s údajmi CRM, integráciu s externými aplikáciami a tiež na vystavenie týchto údajov rozhraniam VTAP Javascript API, ktoré sa majú použiť v rámci vlastných stránok alebo miniaplikácií v používateľskom rozhraní Vtiger.
Rozhrania API môžete vytvárať pomocou jazyka Vtiger Application Design Language (VADL), ktorý je voľne založený na syntaxi XML. VADL umožňuje administrátorom alebo vývojárom bez znalosti programovania na vysokej úrovni ľahko definovať API, ale so základným porozumením programovania vytvoríte efektívne API rýchlo.
Rozhrania REST API sa riadia štandardným protokolom REST API a ich koncové body môžete definovať takto:
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
Pre REST API sú podporované nasledujúce metódy požiadaviek HTTP:
- GET
- POST
- PUT
- DELETE
Pozrime sa, ako môžete použiť VTAP na vytvorenie vlastného rozhrania REST API.
Používatelia Vtiger CRM môžu vytvárať REST API, ktoré prepoja CRM s inými aplikáciami tretích strán alebo vytvárať nové, ktoré rozšíria funkčnosť CRM. Tu je príklad:
Poďme vytvoriť REST API, ktoré dokáže prístupové údaje z konkrétny modul pomocou VTAP.
Nasleduje príklad API, ktoré získava údaje z modulu CRM tzv Organizácia zobraziť päť najlepších organizácií s najvyšším ročným príjmom s názvom API ako top_organizations. Môžete ísť s iným názvom, aby bol jedinečný.
Skôr než začneme, pochopme komponenty XML a VDAL, ktoré sa použijú na definovanie akcií vyššie uvedeného príkladu rozhrania API.
Nasledujúca tabuľka popisuje komponenty XML a VDAL, ktoré sa použijú na definovanie vlastného rozhrania REST API na prístup a zobrazenie údajov CRM:
| Komponent XML a VDAL | akčná |
|---|---|
| api metóda = "získať" | Definovanie metódy HTTP Request |
| vyberte modul = "Účty" | Definujte modul na získavanie údajov z používania vybrať |
| záznam názov poľa=”názov účtu”> | Definujte polia v zázname na získanie údajov z používania záznam |
| druh názov poľa=”ročný_výnos” order=”zostupne” /pole /triediť |
Definujte podmienky pre výsledok tabuľky pomocou druh |
| limit max=”5″ strana=”@strana” /limit | Definujte počet podrobností záznamu, ktoré sa majú zobraziť pomocou obmedziť |
| / vybrať /api |
Ukončite zatvorením všetkých otvorených značiek |
Poznámky že všetky komponenty XML a VDAL vo vyššie uvedenej tabuľke majú byť uzavreté značkami (<>).
Pri zostavovaní rozhrania REST API, o ktorom sa hovorí vyššie, postupujte podľa týchto krokov:
- Prihláste sa do svojho účtu Vtiger CRM.
- Kliknite na tlačidlo Hlavné menu.
- kliknite Plošina.
- vybrať Návrhár API.
- kliknite + Pridať API.
- kliknite vytvoriť vedľa REST API. Otvorí sa okno Pridať REST API.
- Pridajte REST API: Zadajte alebo vyberte informácie pre nasledujúce položky:
- Moduly: Vyberte modul CRM, z ktorého chcete získať prístup k údajom.
- Meno: Zadajte jedinečný identifikátor pre rozhranie API.
- postavenie: Kliknutím na začiarkavacie políčko aktivujte rozhranie API.
- kliknite ušetríte.
- Po pridaní API uvidíte vstavané IDE, kde použijete VADL na definovanie API a uzlov XML na získanie údajov CRM. Pozrite si tabuľku vyššie, aby ste pochopili komponenty XML a VADL.
- kliknite Uložiť a zverejniť na zverejnenie vytvoreného API.
K vyššie uvedenému REST API môžete pristupovať a testovať ho z akejkoľvek externej aplikácie pomocou nasledujúcej adresy URL.
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
Poznámky že vyššie uvedená adresa URL je príkladom a budete musieť definovať koncový bod podľa vašej inštancie CRM.
Vedeli ste?
Vyššie uvedené údaje možno použiť na zobrazenie ako zoznam na vlastnej stránke alebo na použitie v stĺpcovom grafe a iných dynamických výsledkoch pomocou komponentov javascriptu na definovanie vašich rozhraní API. Všetky vlastné REST API zabudované v API Designer sú dostupné aj pomocou VTAP Javascript API.
Ak sa chcete dozvedieť viac o vytváraní vlastných rozhraní API a VTAP, pozrite sa Dokumentácia VTAP.
