Ir para o conteúdo
Início » Seu guia para criar APIs REST

Seu guia para criar APIs REST

API significa Interface de Programação de Aplicativos. Qualquer software com uma função específica é referido como um aplicativo ao discutir APIs. Você pode comparar a interface da API a um contrato de serviço entre dois programas que especificam solicitações e respostas. Se você é novo em APIs, recomendamos que verifique nosso Guia para iniciantes de APIs e Visão geral das APIs REST blog antes de ler este.

APIs REST permitem que você acesse os dados do CRM através do protocolo HTTP/HTTPS. Você pode executar ações como criar, atualizar, recuperar ou excluir operações em qualquer informação de registro do CRM. Ele também permitirá que você armazene dados de configuração específicos da extensão e específicos do usuário ou conecte-se a aplicativos externos usando os dados específicos da extensão armazenados. Todos esses dados podem ser acessados ​​por autorização básica, ou seja, pelo nome de usuário e chave de acesso.

Criando uma API REST

A seguir estão as cinco etapas gerais que você pode usar para criar qualquer API:

  1. Planejar a API: as diretrizes para projetar sua API são fornecidas por especificações de API como OpenAPI. É preferível considerar vários casos de uso de antemão e garantir que a API esteja em conformidade com os padrões atuais de desenvolvimento de API.
  2. Crie a API: os designers de API criam protótipos de novas APIs com poucas modificações nas APIs existentes. Os desenvolvedores podem adaptar o protótipo aos requisitos internos após o teste.
  3. Testar a API: semelhante ao teste de software, o teste de API é necessário para proteger contra erros e falhas. Teste a força da API contra ataques online usando ferramentas para teste de API.
  4. Documente a API: embora as APIs sejam autoexplicativas, a documentação pode ajudar os usuários com mais facilidade. Em uma arquitetura orientada a serviços, APIs bem documentadas com várias funções e casos de uso são usadas com mais frequência. Escreva um documento de ajuda para orientar e ajudar outras pessoas a criar suas APIs.
  5. Comercialize a API: existem mercados online onde os desenvolvedores podem comprar e vender APIs para outras pessoas, assim como existem para produtos de varejo no eBay, Amazon e Flipkart. Você pode ganhar dinheiro com sua API listando-a.

Este blog ensinará como criar um comando de API REST personalizado usando o API Designer do Vtiger. Então vamos começar.

O que é um designer de API?

O Designer de API é uma ferramenta ou desenvolvedores de aplicativos que podem usar para criar APIs de serviço da web customizadas. Você pode definir seus terminais de serviço personalizados e parâmetros de consulta. Essas APIs podem ser usadas para interagir com os dados do CRM, integrar-se com aplicativos externos e também expor esses dados às APIs Javascript do VTAP para serem usadas em páginas ou widgets personalizados na interface do usuário do Vtiger.

Você pode criar APIs usando Vtiger Application Design Language (VADL), que é vagamente baseado na sintaxe XML. O VADL permite que administradores ou desenvolvedores sem habilidades de programação de alto nível definam facilmente APIs, mas com um entendimento básico de programação, você cria APIs eficazes rapidamente.

As APIs REST seguem o protocolo API REST padrão e você pode definir seus endpoints da seguinte maneira:

https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH

Para API REST, os seguintes métodos de solicitação HTTP são suportados:

  • ENTRE
  • POST
  • PUT
  • EXCLUIR

Vamos ver como você pode usar o VTAP para criar sua API REST personalizada.

Os usuários do Vtiger CRM podem criar APIs REST que conectarão o CRM a outros aplicativos de terceiros ou criarão novos que estenderão a funcionalidade do CRM. Aqui está um exemplo:

Vamos criar uma API REST que pode acessar dados de especifico módulo usando o VTAP.

Segue um exemplo do API que recupera dados do módulo CRM chamado Organizações para exibir as cinco principais organizações com a maior receita anual com um nome de API como principais_organizações. Você pode usar um nome diferente para mantê-lo exclusivo.

Antes de começarmos, vamos entender os componentes XML e VDAL que serão usados ​​para definir as ações do exemplo de API acima.

A tabela a seguir descreve os componentes XML e VDAL que serão usados ​​para definir a API REST personalizada para acessar e exibir dados do CRM:

Componente XML e VDAL Açao Social
método api = “obter” Definindo o método de solicitação HTTP
selecione módulo=”Contas” Defina o módulo para recuperar dados usando selecionar
registro
nome do campo=”nome da conta”>
Defina os campos no registro para recuperar dados usando registro
tipo
nome do campo=”receita_anual” pedido=”decrescente” /campo
/organizar
Defina as condições para o resultado da tabela usando tipo
limite máximo=”5″ página=”@página” /limite Defina o número de detalhes do registro a serem exibidos usando limitar
/selecionar
/ api
Termine fechando todas as tags abertas

Note que todos os componentes XML e VDAL na tabela acima devem ser colocados entre tags (<>).

Siga estas etapas para criar a API REST discutida acima:

  1. Faça login na sua conta Vtiger CRM.
  2. Clique na Menu principal.
  3. Clique Plataforma.
  4. Selecionar Designer de API.
  5. Clique +Adicionar API.
  6. image1

  7. Clique Crie ao lado da API REST. A janela Adicionar API REST é aberta.
  8. image4

  9. Adicionar API REST: Insira ou selecione informações para o seguinte:
    1. Módulo: Selecione o módulo CRM a partir do qual os dados devem ser acessados.
    2. Nome: insira um identificador exclusivo para a API.
    3. Status: Clique na caixa de seleção para ativar a API.
  10. Clique Salvar.
  11. image2

  12. Depois de adicionar a API, você verá um IDE integrado no qual usará VADL para definir APIs e nós XML para recuperar dados de CRM. Consulte a tabela acima para entender os componentes XML e VADL.
  13. image3

  14. Clique Salvar e publicar para publicar a API construída.

Você pode acessar e testar a API REST acima de qualquer aplicativo externo usando o URL a seguir.

https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations

Note que a URL acima é um exemplo e você terá que definir o endpoint de acordo com sua instância de CRM.

Sabia que?
Os dados acima podem ser usados ​​para mostrar como uma lista em uma página personalizada ou para um gráfico de barras e outros resultados dinâmicos usando componentes javascript para definir suas APIs. Todas as APIs REST personalizadas criadas no API Designer também podem ser acessadas usando APIs Javascript VTAP.

Para saber mais sobre como criar APIs personalizadas e VTAP, confira Documentação VTAP.