Banner voor rest-API's bouwen (1)

Uw gids voor het bouwen van REST API's


API staat voor Application Programming Interface. Elke software met een specifieke functie wordt een applicatie genoemd bij het bespreken van API's. U kunt de API-interface vergelijken met een serviceovereenkomst tussen twee programma's die verzoeken en antwoorden specificeren. Als u nieuw bent met API's, raden we u aan onze te bekijken Beginnersgids voor API's en Overzicht naar REST API's blog voordat je deze leest.

REST API's kunt u toegang krijgen tot CRM-gegevens via het HTTP/HTTPS-protocol. U kunt acties uitvoeren zoals het maken, bijwerken, ophalen of verwijderen van alle CRM-recordinformatie. Hiermee kunt u ook extensiespecifieke en gebruikersspecifieke configuratiegegevens opslaan of verbinding maken met externe applicaties met behulp van de opgeslagen extensiespecifieke gegevens. Al deze gegevens zijn toegankelijk via basisautorisatie, dat wil zeggen door de gebruikersnaam en toegangssleutel.

Een REST-API maken

Hieronder volgen de vijf algemene stappen die u kunt gebruiken om een ​​API te bouwen:
  1. Plan de API: De richtlijnen voor het ontwerpen van uw API worden geleverd door API-specificaties zoals OpenAPI. Het verdient de voorkeur om vooraf verschillende use cases te overwegen en ervoor te zorgen dat de API voldoet aan de huidige API-ontwikkelstandaarden.
  2. Bouw de API: API-ontwerpers maken prototypen van nieuwe API's met weinig aanpassingen aan de bestaande API's. Ontwikkelaars kunnen het prototype na het testen aanpassen aan interne vereisten.
  3. Test de API: Net als bij het testen van software, is API-testen noodzakelijk om te beschermen tegen fouten en gebreken. Test de API op kracht tegen online aanvallen met behulp van tools voor API-testen.
  4. Documenteer de API: Hoewel API's voor zichzelf spreken, kan documentatie gebruikers gemakkelijker helpen. In een servicegerichte architectuur wordt vaker gebruik gemaakt van goed gedocumenteerde API's met verschillende functies en use cases. Schrijf een helpdocument om richting te geven en anderen te helpen hun API's te bouwen.
  5. Breng de API op de markt: Er zijn online marktplaatsen waar ontwikkelaars API's kunnen kopen en verkopen aan anderen, net zoals er zijn voor winkelartikelen op eBay, Amazon en Flipkart. U kunt geld verdienen met uw API door deze te vermelden.
Deze blog leert je hoe je een aangepaste REST API-opdracht kunt bouwen met behulp van Vtiger's API Designer. Dus laten we beginnen.

Wat is een API-ontwerper?

De API Designer is een tool of applicatie die ontwikkelaars kunnen gebruiken om aangepaste webservice-API's te bouwen. U kunt uw aangepaste service-eindpunten en queryparameters definiëren. Deze API's kunnen worden gebruikt om te communiceren met CRM-gegevens, te integreren met externe apps en deze gegevens ook bloot te stellen aan VTAP Javascript-API's voor gebruik binnen aangepaste pagina's of widgets in Vtiger UI.

U kunt API's maken met Vtiger Application Design Language (VADL), die losjes gebaseerd is op de XML-syntaxis. Met de VADL kunnen beheerders of ontwikkelaars zonder programmeervaardigheden op hoog niveau eenvoudig API's definiëren, maar met een basiskennis van programmeren creëer je snel effectieve API's.

REST API's volgen het standaard REST API-protocol en u kunt hun eindpunten als volgt definiëren:
https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

Voor REST API worden de volgende HTTP-aanvraagmethoden ondersteund:
  • GET
  • POST
  • PUT
  • VERWIJDEREN
Laten we eens kijken hoe u VTAP kunt gebruiken om uw aangepaste REST API te bouwen.

Vtiger CRM-gebruikers kunnen REST API's bouwen die de CRM verbinden met andere applicaties van derden of nieuwe bouwen die de functionaliteit van de CRM uitbreiden. Hier is een voorbeeld:

Laten we een REST API maken die dat wel kan toegang tot gegevens van een specifiek module met behulp van de VTAP.

Hierna volgt een voorbeeld van de API die gegevens ophaalt vanuit de CRM-module aangeroepen organisaties om de top vijf van organisaties met de hoogste jaaromzet weer te geven met een API-naam als top_organisaties. Je kunt een andere naam gebruiken om het uniek te houden.

Laten we, voordat we beginnen, de XML- en VDAL-componenten begrijpen die zullen worden gebruikt om de acties van het bovenstaande API-voorbeeld te definiëren.

De volgende tabel beschrijft de XML- en VDAL-componenten die zullen worden gebruikt om de aangepaste REST API te definiëren voor toegang tot en weergave van CRM-gegevens:
XML en VDAL-component Actie
api-methode = "krijgen" HTTP-aanvraagmethode definiëren
select module=”Rekeningen” Definieer de module waarvan gegevens moeten worden opgehaald kiezen
record veldnaam=”accountnaam”> Definieer de velden in het record waaruit gegevens moeten worden opgehaald record
sorteer veldnaam=”annual_revenue” order=”aflopend” /veld /sort Definieer de voorwaarden voor de tabeluitkomst met behulp van sorteren
limit max=”5″ page=”@page” /limit Definieer het aantal recorddetails dat moet worden weergegeven met begrenzing
/selecteer /api Eindig met het sluiten van alle open tags
Opmerking: dat alle XML- en VDAL-componenten in de bovenstaande tabel moeten worden ingesloten met tags (<>).

Volg deze stappen om de hierboven besproken REST API te bouwen:
  1. Log in op uw Vtiger CRM-account.
  2. Klik op de Hoofdmenu.
  3. Klik Platform.
  4. kies API-ontwerper.
  5. Klik +API toevoegen.

  6. image1
  7. Klik creëren naast REST API. Het venster REST API toevoegen wordt geopend.

  8. image4
  9. REST-API toevoegen: Voer informatie in of selecteer deze voor het volgende:
    1. Module: Selecteer de CRM-module van waaruit gegevens moeten worden opgevraagd.
    2. Naam: Voer een unieke identificatie voor de API in.
    3. Status: Klik op het selectievakje om de API te activeren.
  10. Klik Bespaar.

  11. image2
  12. Nadat u de API hebt toegevoegd, ziet u een ingebouwde IDE waarin u VADL gaat gebruiken om API's en XML-knooppunten te definiëren om CRM-gegevens op te halen. Raadpleeg de bovenstaande tabel om de XML- en VADL-componenten te begrijpen.

  13. image3
  14. Klik Opslaan en publiceren om de gebouwde API te publiceren.
U kunt de bovenstaande REST API openen en testen vanuit elke externe applicatie met behulp van de volgende URL.
https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Opmerking: dat de bovenstaande URL een voorbeeld is en dat u het eindpunt moet definiëren volgens uw CRM-exemplaar.

Wist u dat? De bovenstaande gegevens kunnen worden gebruikt om als een lijst op een aangepaste pagina te worden weergegeven of worden gebruikt voor een staafdiagram en andere dynamische resultaten met behulp van javascript-componenten om uw API's te definiëren. Alle aangepaste REST API's die in API Designer zijn ingebouwd, zijn ook toegankelijk via VTAP Javascript API's.

Ga naar voor meer informatie over het bouwen van aangepaste API's en VTAP VTAP-documentatie.

Copyright 2023 Vtiger | Privacybeleid | Beleid en juridisch centrum