In precedenza, nella nostra serie di blog Vtiger Application Platform (VTAP), abbiamo discusso su come personalizzare l'interfaccia Vtiger e introdurre pulsanti e widget personalizzati per soddisfare esigenze aziendali specifiche. Questa è solo una delle funzionalità offerte dalla piattaforma.
VTAP ti offre molte di queste funzionalità che ti aiutano a:
- Crea un'API REST personalizzata
- Connettiti ad altre applicazioni che hanno API REST disponibile
- Connettiti ad applicazioni abilitate per OAuth
In questo blog, parlerò di come creare un'API REST personalizzata.
Innanzitutto, lasciatemi parlare un po' delle API REST di Vtiger. È possibile accedervi con l'endpoint sottostante, che sarà specifico per la tua istanza CRM.
Per esempio,https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default
Se sei a conoscenza del Vtiger API REST, quindi puoi saltare la sezione sottostante. Per conoscere i moduli accessibili, puoi utilizzare il tipi di lista API.
Ecco uno screenshot di come è possibile accedere all'API utilizzando il client Postman.
Vtiger fornisce già un set standard di API, ma con il nuovo strumento API Designer, ora puoi scrivere le tue API REST personalizzate.
Progettazione API
API Designer fornisce un workbench per gli sviluppatori per sviluppare API basate su HTTP che possono essere esposte alle API Javascript VTAP o all'applicazione esterna per una facile integrazione. Le API possono essere definite usando VADL specifiche.
L'accesso all'API richiede l'autorizzazione dell'utente e segue la configurazione standard dell'accesso ai record effettuata all'interno del CRM.
L'API Designer fornisce IDE per scrivere API personalizzate. Se scrivi un'API REST personalizzata per un particolare modulo, devi assegnare un nome all'API e selezionare il modulo.
Abbiamo definito Vtiger Application Definition Language (VADL), che si basa sulla sintassi XML per consentire agli amministratori o agli sviluppatori inesperti di definire API senza esperienza di programmazione.
VADL ti permette di:
- Definisci CAGLIATA
- API (Crea, Aggiorna, Recupera, Elimina) sui moduli di entità
- Richiamare l'endpoint basato su HTTP (REST/SOAP) tramite i metodi (GET/POST/PUT/DELETE)
- Con autenticazione (basata su token di base/al portatore)
- Accetta i parametri di richiesta e associa come input API
Facciamo un esempio di creazione di un'API REST personalizzata che cercherà i contatti corrispondenti al dominio di posta elettronica. Aggiungeremo una nuova API con il nome 'fetch_email_contact' e selezioneremo il modulo Contatti
Tutte le definizioni sono poste all'interno di an API nodo con tipo HTTP standard (get, post, put ed delete). Poiché stiamo recuperando i dati da CRM, useremo seleziona nodi e passare i nomi dei moduli. Avremo campi che devono essere recuperati all'interno del record nodo e qualsiasi condizione di filtro all'interno del where nodo. Supportiamo diversi tipi di condizioni come uguale, non uguale, come, maggiore di, minore di, ecc.
Sopra c'è un semplice esempio, che può essere realizzato anche utilizzando l'esistente domanda API REST. Il vero potere diventa evidente quando si combinano più API in una.
Considera questo esempio. Si aggiorna un record se esiste o se ne crea uno se non esiste. Se utilizzi un'API esistente, saranno necessarie più chiamate per eseguire queste operazioni. Ma quando utilizzi API Designer, puoi combinare queste operazioni in un'unica chiamata API.
Nell'esempio sopra, stiamo inserendo la definizione all'interno di capovolto nodo. Questo comprende il update ed creare nodo, che aggiornerà un record se esiste o creerà un record se non esiste. Per identificare il record che deve essere aggiornato, puoi utilizzare dove filtrare e trovare le voci pertinenti. Al termine della definizione, il nodo di ritorno restituirà i campi definiti al client.
Puoi salvare e pubblicare queste API per renderle disponibili per applicazioni esterne e Javascript VTAP interno.
Accesso a un'API personalizzata pubblicata tramite API Designer
- Per accedere a qualsiasi API personalizzata pubblicata tramite API Designer, dovrai utilizzare l'endpoint seguente.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/NOME_API?PARAMETRI
- API_NAME dovrebbe essere sostituito con il nome dato all'API. Inoltre, assicurati di utilizzare il tipo HTTP appropriato e Credenziali(nome utente e chiave di accesso) per accedervi.
Accedere a una creazione di recente recupera_email_contatto API tramite postino
- Per accedere a una creazione di recente recupera_email_contatto API che utilizza postino, dovresti usare quanto segue.
- https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%
Note: : https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% è deprecato.
È possibile accedere a queste API internamente in Module Designer utilizzando VTAP Javascript API VTAP.CustomApi.Get da visualizzare all'interno di un widget o di pagine personalizzate nell'interfaccia utente di Vtiger.
Per concludere, abbiamo visto come lo strumento API Designer ti consente di scrivere API REST personalizzate e utilizzarle internamente e in altre applicazioni per consumare i dati CRM senza problemi.
Per qualsiasi altra domanda, inviare un'e-mail a [email protected]. Registrati per l'edizione per sviluppatori qui.
