Banner delle API di Building Rest (1)

La tua guida alla creazione di API REST


API è l'acronimo di Application Programming Interface. Qualsiasi software con una funzione specifica viene definito applicazione quando si parla di API. Puoi confrontare l'interfaccia API con un contratto di servizio tra due programmi che specificano richieste e risposte. Se non conosci le API, ti consigliamo di dare un'occhiata al nostro Guida per principianti alle API e Panoramica delle API REST blog prima di leggere questo.

API REST consentono di accedere ai dati del CRM attraverso il protocollo HTTP/HTTPS. È possibile eseguire azioni come creare, aggiornare, recuperare o eliminare operazioni su qualsiasi informazione del record CRM. Consente inoltre di archiviare i dati di configurazione specifici dell'estensione e dell'utente o di connettersi ad applicazioni esterne utilizzando i dati specifici dell'estensione memorizzati. Tutti questi dati sono accessibili tramite autorizzazione di base, ovvero tramite nome utente e chiave di accesso.

Creazione di un'API REST

Di seguito sono riportati i cinque passaggi generali che puoi utilizzare per creare qualsiasi API:
  1. Pianifica l'API: le linee guida per la progettazione della tua API sono fornite dalle specifiche API come OpenAPI. È preferibile considerare in anticipo vari casi d'uso e assicurarsi che l'API sia conforme agli attuali standard di sviluppo API.
  2. Crea l'API: i progettisti di API creano prototipi di nuove API con poche modifiche alle API esistenti. Gli sviluppatori possono adattare il prototipo ai requisiti interni dopo che è stato sottoposto a test.
  3. Testare l'API: Simile al test del software, il test API è necessario per proteggersi da errori e difetti. Testa la forza dell'API contro gli attacchi online utilizzando gli strumenti per il test dell'API.
  4. Documenta l'API: Sebbene le API siano autoesplicative, la documentazione può aiutare gli utenti più facilmente. In un'architettura orientata ai servizi, vengono utilizzate più frequentemente API ben documentate con varie funzioni e casi d'uso. Scrivi un documento di aiuto per dare indicazioni e aiutare gli altri a creare le loro API.
  5. Commercializza l'API: Esistono mercati online in cui gli sviluppatori possono acquistare e vendere API ad altri, proprio come ci sono per i prodotti al dettaglio su eBay, Amazon e Flipkart. Puoi guadagnare denaro dalla tua API elencandola.
Questo blog ti insegnerà come creare un comando API REST personalizzato utilizzando l'API Designer di Vtiger. Quindi iniziamo.

Cos'è un progettista API?

L'API Designer è uno strumento o gli sviluppatori di applicazioni che possono utilizzare per creare API di servizi Web personalizzate. Puoi definire i tuoi endpoint di servizio personalizzati e i parametri di query. Queste API possono essere utilizzate per interagire con i dati CRM, integrarsi con app esterne ed anche esporre questi dati alle API Javascript VTAP da utilizzare all'interno di pagine o widget personalizzati nell'interfaccia utente di Vtiger.

Puoi creare API usando Vtiger Application Design Language (VADL), che è vagamente basato sulla sintassi XML. Il VADL consente agli amministratori o agli sviluppatori senza competenze di programmazione di alto livello di definire facilmente le API, ma con una conoscenza di base della programmazione, puoi creare rapidamente API efficaci.

Le API REST seguono il protocollo API REST standard e puoi definire i loro endpoint come segue:
https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

Per l'API REST, sono supportati i seguenti metodi di richiesta HTTP:
  • GET
  • POST
  • PUT
  • DELETE
Vediamo come puoi utilizzare VTAP per creare la tua API REST personalizzata.

Gli utenti di Vtiger CRM possono creare API REST che collegheranno il CRM ad altre applicazioni di terze parti o ne creeranno di nuove che estenderanno le funzionalità del CRM. Ecco un esempio:

Creiamo un'API REST che può accedere ai dati da Uno specifico modulo utilizzando il VTAP.

Di seguito è riportato un esempio di API che recupera i dati dal modulo CRM chiamato Organizations per visualizzare le prime cinque organizzazioni con il fatturato annuo più alto con un nome API come top_organizzazioni. Puoi andare con un nome diverso per mantenerlo unico.

Prima di iniziare, cerchiamo di comprendere i componenti XML e VDAL che verranno utilizzati per definire le azioni dell'esempio API precedente.

La tabella seguente descrive i componenti XML e VDAL che verranno utilizzati per definire l'API REST personalizzata per accedere e visualizzare i dati CRM:
Componente XML e VDAL Action
metodo api = "ottieni" Definizione del metodo di richiesta HTTP
select module=”Account” Definire il modulo da utilizzare per recuperare i dati select
nome campo record=”nomeaccount”> Definire i campi nel record per recuperare i dati dall'utilizzo record
sort field name=”annual_revenue” order=”discendente” /field /sort Definire le condizioni per il risultato della tabella utilizzando sorta
limite max=”5″ pagina=”@pagina” /limite Definire il numero di dettagli del record da visualizzare utilizzando limitare
/seleziona /api Termina chiudendo tutti i tag aperti
Note: che tutti i componenti XML e VDAL nella tabella sopra devono essere racchiusi tra tag (<>).

Segui questi passaggi per creare l'API REST discussa sopra:
  1. Accedi al tuo account Vtiger CRM.
  2. Clicca su Menu principale.
  3. Clicchi Piattaforma.
  4. Seleziona Progettazione API.
  5. Clicchi +Aggiungi API.

  6. image1
  7. Clicchi Creare accanto all'API REST. Si apre la finestra Aggiungi API REST.

  8. image4
  9. Aggiungi l'API REST: immettere o selezionare le informazioni per quanto segue:
    1. Modulo: Seleziona il modulo CRM da cui accedere ai dati.
    2. Nome: immettere un identificatore univoco per l'API.
    3. STATO: fare clic sulla casella di controllo per attivare l'API.
  10. Clicchi Risparmi.

  11. image2
  12. Dopo aver aggiunto l'API, vedrai un IDE integrato in cui utilizzerai VADL per definire API e nodi XML per recuperare i dati CRM. Fare riferimento alla tabella precedente per comprendere i componenti XML e VADL.

  13. image3
  14. Clicchi Salva e pubblica per pubblicare l'API creata.
Puoi accedere e testare l'API REST di cui sopra da qualsiasi applicazione esterna utilizzando il seguente URL.
https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Note: che l'URL sopra è un esempio e dovrai definire l'endpoint come per la tua istanza CRM.

Lo sapevate? I dati di cui sopra possono essere utilizzati per essere visualizzati come un elenco su una pagina personalizzata o utilizzati per un grafico a barre e altri risultati dinamici utilizzando componenti javascript per definire le tue API. È inoltre possibile accedere a tutte le API REST personalizzate create in API Designer utilizzando API Javascript VTAP.

Per saperne di più sulla creazione di API personalizzate e VTAP, dai un'occhiata Documentazione VTAP.

Copyright 2023 Vtiger | Privacy | Centro legale e politico