Hoppa till innehåll
Hem » Din guide till att bygga REST API:er

Din guide till att bygga REST API:er

Senast uppdaterad: 10 maj 2023

Publicerad: Februari 6, 2023

API står för Application Programming Interface. Varje mjukvara med en specifik funktion hänvisas till som en applikation när man diskuterar API:er. Du kan jämföra API-gränssnittet med ett serviceavtal mellan två program som anger förfrågningar och svar. Om du är ny på API:er rekommenderar vi att du kollar in vår Nybörjarguide till API:er och Översikt över REST API:er blogga innan du läser den här.

REST API: er låter dig komma åt CRM-data via HTTP/HTTPS-protokollet. Du kan utföra åtgärder som att skapa, uppdatera, hämta eller ta bort operationer på vilken CRM-postinformation som helst. Det låter dig också lagra tilläggsspecifika och användarspecifika konfigurationsdata eller ansluta till externa applikationer med hjälp av lagrad tilläggsspecifik data. Alla dessa data kan nås med grundläggande behörighet, det vill säga med användarnamn och åtkomstnyckel.

Skapa ett REST API

Följande är de fem allmänna stegen som du kan använda för att bygga valfritt API:

  1. Planera API: Riktlinjerna för att utforma ditt API tillhandahålls av API-specifikationer som OpenAPI. Det är att föredra att överväga olika användningsfall i förväg och se till att API:n överensstämmer med nuvarande API-utvecklingsstandarder.
  2. Bygg API: API-designers skapar prototyper av nya API:er med liten modifiering av de befintliga API:erna. Utvecklare kan anpassa prototypen till interna krav efter att den har genomgått testning.
  3. Testa API: I likhet med mjukvarutestning är API-testning nödvändig för att skydda sig mot fel och brister. Testa API:et för styrka mot onlineattacker med hjälp av verktyg för API-testning.
  4. Dokumentera API:et: Även om API:er är självförklarande kan dokumentationen hjälpa användarna lättare. I en tjänsteorienterad arkitektur används oftare väldokumenterade API:er med olika funktioner och användningsfall. Skriv ett hjälpdokument för att ge vägledning och hjälpa andra att bygga sina API:er.
  5. Marknadsför API:et: Det finns onlinemarknadsplatser där utvecklare kan köpa och sälja API:er till andra, precis som det finns för detaljhandelsvaror på eBay, Amazon och Flipkart. Du kan tjäna pengar på ditt API genom att lista det.

Den här bloggen kommer att lära dig hur du bygger ett anpassat REST API-kommando med Vtigers API Designer. Så låt oss börja.

Vad är en API-designer?

API-designern är ett verktyg eller applikationsutvecklare kan använda för att bygga anpassade webbtjänst-API:er. Du kan definiera dina anpassade tjänstslutpunkter och frågeparametrar. Dessa API:er kan användas för att interagera med CRM-data, integrera med externa appar och även exponera dessa data för VTAP Javascript API:er för att användas inom anpassade sidor eller widgets i Vtiger UI.

Du kan skapa API:er med Vtiger Application Design Language (VADL), som är löst baserat på XML-syntax. VADL gör det möjligt för administratörer eller utvecklare utan programmeringskunskaper på hög nivå att enkelt definiera API:er, men med en grundläggande förståelse för programmering skapar du effektiva API:er snabbt.

REST API:er följer standard REST API-protokoll, och du kan definiera deras slutpunkter enligt följande:

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

För REST API stöds följande HTTP-begäransmetoder:

  • FÅ
  • POST
  • SÄTTA
  • RADERA

Låt oss se hur du kan använda VTAP för att bygga ditt anpassade REST API.

Vtiger CRM-användare kan bygga REST API: er som kommer att ansluta CRM till andra tredjepartsapplikationer eller bygga nya som kommer att utöka CRM:s funktionalitet. Här är ett exempel:

Låt oss skapa ett REST API som kan komma åt data från en specifik modul med hjälp av VTAP.

Följande är ett exempel på API som hämtar data från CRM-modulen som kallas Organisationer för att visa de fem bästa organisationerna med de högsta årliga intäkterna med ett API-namn som top_organisationer. Du kan välja ett annat namn för att hålla det unikt.

Innan vi börjar, låt oss förstå XML- och VDAL-komponenterna som kommer att användas för att definiera åtgärderna i ovanstående API-exempel.

Följande tabell beskriver XML- och VDAL-komponenterna som kommer att användas för att definiera det anpassade REST-API:et för att komma åt och visa CRM-data:

XML- och VDAL-komponent Handling
api method="get" Definierar metod för HTTP-begäran
välj modul = "Konton" Definiera modulen för att hämta data från att använda välj
post
field name="kontonamn">
Definiera fälten i posten för att hämta data från användning post
sortera
field name=”annual_revenue” order=”fallande” /fält
/sortera
Definiera villkoren för tabellens resultat med hjälp av sortera
limit max="5″ page="@page" /limit Definiera antalet postdetaljer som ska visas med hjälp av begränsa
/Välj
/api
Avsluta med att stänga alla öppna taggar

Anmärkningar att alla XML- och VDAL-komponenter i tabellen ovan ska omges av taggar(<>).

Följ dessa steg för att bygga REST API som diskuteras ovan:

  1. Logga in på ditt Vtiger CRM-konto.
  2. Klicka på Huvudmeny.
  3. Klicka plattform.
  4. Välja API-designer.
  5. Klicka +Lägg till API.
  6. image1

  7. Klicka Skapa bredvid REST API. Fönstret Lägg till REST API öppnas.
  8. image4

  9. Lägg till REST API: Ange eller välj information för följande:
    1. Modulerna: Välj den CRM-modul från vilken data ska nås.
    2. Namn : Ange en unik identifierare för API:t.
    3. Status: Klicka på kryssrutan för att aktivera API.
  10. Klicka Spara.
  11. image2

  12. När du har lagt till API:t kommer du att se en inbyggd IDE där du kommer att använda VADL för att definiera API:er och XML-noder för att hämta CRM-data. Se tabellen ovan för att förstå XML- och VADL-komponenterna.
  13. image3

  14. Klicka Spara och publicera för att publicera det inbyggda API:et.

Du kan komma åt och testa ovanstående REST API från vilken extern applikation som helst med hjälp av följande URL.

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

Anmärkningar att ovanstående URL är ett exempel, och du måste definiera slutpunkten enligt din CRM-instans.

Visste du att?
Ovanstående data kan användas för att visa som en lista på en anpassad sida eller användas för ett stapeldiagram och andra dynamiska resultat med hjälp av javascript-komponenter för att definiera dina API:er. Alla anpassade REST API: er inbyggda i API Designer kan också nås med hjälp av VTAP Javascript API: er.

För att veta mer om att bygga anpassade API:er och VTAP, kolla in VTAP-dokumentation.

✦
Styr din affärstillväxt med Vtigers allt-i-ett CRM.
Prova Vtiger Gratis