Buscar
  • Larissa Rodrigues

Introdução ao VTAP API Designer - Parte 2


Anteriormente, em nossa série de blog Vtiger Application Platform (VTAP), discutimos como personalizar a interface do Vtiger e trazer botões e widgets personalizados para atender às necessidades de negócios específicas. Este é apenas um recurso que a plataforma oferece.

O VTAP capacita você com muitos desses recursos que o ajudam:

  • Crie uma API REST personalizada

  • Conecte-se a outros aplicativos que tenham API REST disponível

  • Conectar-se a aplicativos habilitados para OAuth

Neste blog, irei discutir como podemos criar uma API REST customizada. Primeiro, deixe-me falar um pouco sobre as APIs REST do Vtiger. Ele pode ser acessado com o endpoint abaixo, que será específico para sua instância de CRM. Por exemplo, https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default Se você conhece a API Vtiger Rest , pode pular a seção abaixo. Para saber sobre os módulos acessíveis, você pode usar a API listtypes . Aqui está uma captura de tela de como você pode acessar a API usando o cliente Postman.


Vtiger já fornece um conjunto padrão de APIs, mas com a nova ferramenta API Designer, agora você pode escrever suas próprias APIs REST personalizadas.

API Designer O API Designer fornece um ambiente de trabalho para desenvolvedores desenvolverem APIs baseadas em HTTP que podem ser expostas ao tempo de execução VTAP ou ao aplicativo externo para fácil integração. As APIs podem ser definidas usando especificações VADL . O acesso à API precisa da autorização do usuário e segue a configuração padrão de acesso ao registro feita no CRM. O API Designer fornece IDE para escrever APIs personalizadas. Se você escrever uma API REST customizada para um módulo específico, será necessário nomear a API e selecionar o módulo.


Definimos Vtiger Application Definition Language (VADL), que se baseia na sintaxe XML para permitir que administradores ou desenvolvedores novatos definam API sem experiência em programação.

VADL permite que você:

  • Definir CURD

  • APIs (criar, atualizar, recuperar, excluir) em módulos de entidade

  • Invocar ponto de extremidade baseado em HTTP (REST / SOAP) por meio de métodos (GET / POST / PUT / DELETE)

  • Com autenticação (básico / baseado em token do portador)

  • Aceite os parâmetros de solicitação e vincule-os como entradas da API


Vamos dar um exemplo de criação de uma API REST customizada que pesquisará Contatos que correspondam ao domínio de email. Vamos adicionar uma nova API com o nome 'fetch_email_contact' e selecionar o módulo Contatos.


Todas as definições são colocadas dentro de um nó de API com tipo HTTP padrão (get, post, put e delete). Como estamos buscando dados do CRM, usaremos nós selecionados e passaremos os nomes dos módulos. Teremos campos que precisam ser buscados dentro do nó de registros e quaisquer condições de filtro dentro do nó where . Suportamos diferentes tipos de condições, como igual, não igual, igual, maior que, menor que, etc. Acima está um exemplo simples, que também pode ser obtido usando a API REST de consulta existente .

O poder real se torna aparente quando você combina várias APIs em uma. Considere este exemplo. Você atualiza um registro, se existir, ou cria um, se ainda não existir. Se você usar uma API existente, serão necessárias várias chamadas para realizar essas operações. Mas quando você usa o API Designer, pode combinar essas operações em uma única chamada de API.


No exemplo acima, estamos colocando a definição dentro do nó upsert . Isso compreende o nó de atualização e criação , que atualizará um registro se ele existir ou criará um registro se ele não existir. Para identificar o registro que precisa ser atualizado, você pode usar o onde filtrar e encontrar entradas relevantes. No final da definição, o nó de retorno enviará de volta os campos definidos ao cliente. Você pode salvar e publicar essas APIs para disponibilizá-las para aplicativos externos, bem como para o tempo de execução VTAP interno.

Acessando uma API personalizada publicada por meio do API Designer

  • Para acessar qualquer API personalizada publicada por meio do API Designer, você precisará usar o endpoint abaixo.

  • https://your_instance.odx.vtiger.com/restapi/V1/ApiDesigner/api/API_NAME?PARAMETERS

  • API_NAME deve ser substituído pelo nome dado à API. Além disso, certifique-se de usar o tipo de HTTP apropriado e as credenciais (nome de usuário e chave de acesso) para acessá-lo.


Acessando uma API fetch_email_contact criada recentemente usando o carteiro

  • Para acessar uma API fetch_email_contact criada recentemente usando o postman, você deve usar o abaixo.

  • https://your_instance.odx.vtiger.com/restapi/V1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com%



Essas APIs podem ser acessadas internamente no Module Designer usando a API de tempo de execução VTAP VTAP.CustomApi.Get para exibir dentro de um widget ou páginas personalizadas na interface do usuário Vtiger.


Para concluir, vimos como a ferramenta API Designer permite escrever APIs REST customizadas e usá-las internamente e em outros aplicativos para consumir dados de CRM de forma integrada.


Para qualquer outra dúvida, envie um e-mail para platform@vtiger.com. Inscreva-se para a edição do desenvolvedor aqui .

3 visualizações0 comentário