API, sigla em inglês de interface de programação de aplicativo, é uma ferramenta para aplicativos de software. Por exemplo, em um restaurante, o garçom carrega os pratos da cozinha até a sua mesa. A API funciona de maneira semelhante: ela leva os dados de um ponto até outro.
A API também tem como função fazer alterações em itens no TOTVS CRM. Imagine descrever ao garçom como você gostaria que seu filé fosse preparado. O chef mudaria o filé para se adequar a você. Da mesma forma, a API é um recurso poderoso, que muitos clientes usam para importar em massa recursos, criar aplicativos, extrair dados para fontes externas e muito mais.
Na API, o prato é chamado de recurso e o garçom que o leva até você é chamado de ponto de extremidade. Imagine um prato específico que você possa pedir em um restaurante. Alguns pontos de extremidade trazem a você uma coleção de itens, como um prato de amostras. Por exemplo:
Talvez você esteja se perguntando: "que diferença a API faz para mim"?
Resumidamente, você pode usar a API para adicionar funções que não estão disponíveis na interface de usuário (nativamente ou em nível de seu plano) de maneira muito mais ágil do que manualmente.
O uso da API permite que você tenha um método direto de exportar seus dados sem a necessidade de ferramentas de integração. De modo semelhante, por exemplo, você pode usar a API para obter dados dos leads. A API pode retornar todas as informações relacionadas a um lead, portanto você pode usar a saída da API para transferir dados a um aplicativo de relatórios de terceiros.
A capacidade de atualizar e inserir rapidamente vários registros é outro benefício do uso da API. Por exemplo, enquanto você consegue criar apenas uma único lead de cada vez na interface do TOTVS CRM, é possível criar quantos leads quiser com a API.
Criação de atividades.
Migração de dados de outro CRM para o TOTVS CRM.
Edição de clientes em massa.
Pesquisa de registros.
Além de várias outras que podem simplificar a usabilidade do TOTVS CRM!
A API de integração está disponível para os usuários com os planos Consultor de vendas, Gestor e IT.
Se o seu plano não for um dos citados e deseja ter acesso à API de integração, entre em contato com a TOTVS para contratação de um novo plano.
A maior parte da documentação de referência da API do TOTVS CRM está disponível na seção da REST API do repositório do desenvolvedor do TOTVS CRM. A documentação de referência descreve todos os pontos de extremidade disponíveis.
Artigos relacionados:
Formato, métodos e retorno das requisições