Anteriormente, em nossa série de blogs Vtiger Application Platform (VTAP), discutimos como personalizar a interface Vtiger e trazer botões e widgets personalizados para atender às necessidades específicas de negócios. Este é apenas um recurso que a plataforma oferece.
O VTAP capacita você com muitos desses recursos que ajudam você a:
- 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, discutirei como podemos criar uma API REST personalizada.
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ê está ciente do Vtiger API de descanso, então você pode pular a seção abaixo. Para saber sobre os módulos acessíveis, você pode usar o tipos de lista API.
Aqui está uma captura de tela de como você pode acessar a API usando o cliente carteiro.
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.
Designer de API
O API Designer fornece um ambiente de trabalho para desenvolvedores desenvolverem APIs baseadas em HTTP que podem ser expostas às APIs Javascript VTAP ou ao aplicativo externo para fácil integração. APIs podem ser definidas usando VADL especificações.
O acesso à API precisa de autorização do usuário e segue a configuração padrão de acesso ao registro feita dentro do CRM.
O API Designer fornece IDE para escrever APIs personalizadas. Se você escrever uma API REST personalizada para um módulo específico, precisará 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 endpoint 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. Adicionaremos uma nova API com o nome 'fetch_email_contact' e selecionaremos o módulo Contatos
Todas as definições são colocadas dentro de um API nó com tipo HTTP padrão (get, post, put e delete). Como estamos buscando dados do CRM, usaremos selecionar nós e passar nomes de módulos. Teremos campos que precisam ser buscados dentro do nó de registros e quaisquer condições de filtro dentro do onde nó. Oferecemos suporte a diferentes tipos de condições igual, diferente, igual, maior que, menor que, etc.
Acima está um exemplo simples, que também pode ser alcançado usando o existente pergunta API REST. 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 upser nó. Isso compreende o atualizar e crio nó, que atualizará um registro se existir ou criará um registro se não existir. Para identificar o registro que precisa ser atualizado, você pode usar o where para filtrar e encontrar entradas relevantes. No final da definição, o nó de retorno enviará de volta os campos definidos para o cliente.
Você pode salvar e publicar essas APIs para disponibilizá-las para aplicativos externos, bem como Javascript 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/vtap/api/API_NAME? PARÂMETROS
- API_NAME deve ser substituído pelo nome dado à API. Além disso, certifique-se de que está usando o tipo de HTTP apropriado e Credenciais(nome de usuário e chave de acesso) para acessá-lo.
Acessando um criado recentemente buscar_email_contato API usando carteiro
- Para acessar um criado recentemente buscar_email_contato API usando carteiro, você deve usar o abaixo.
- 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% está obsoleto.
Essas APIs podem ser acessadas internamente no Module Designer usando VTAP Javascript API 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 que você escreva APIs REST personalizadas e as use internamente e em outros aplicativos para consumir dados de CRM sem problemas.
Para qualquer outra dúvida, envie um e-mail para [email protegido]. Inscreva-se na edição do desenvolvedor SUA PARTICIPAÇÃO FAZ A DIFERENÇA.
