Mudanças entre as edições de "APIs"

Edição atual tal como às 18h00min de 9 de agosto de 2024

Objetivo

Essa página tem como objetivo reunir as documentações das API's usadas com o ERP Voalle.

Definição

A sigla API significa "Application Programming Interface" ou "Interface de Programação de Aplicação". É usada para nomear um conjunto de rotinas e padrões de programação para acesso a um software ou plataforma baseados na web. Uma API é criada quando o desenvolvedor quer que outros desenvolvedores criem produtos e serviços associados ao seu, de maneira padronizada e de fácil manutenção. Basicamente, uma API é um programa que fica entre dois sistemas e funciona como tradutor-mensageiro, fazendo a comunicação entre esses dois sistemas.

A Voalle desenvolveu diversas API's pensando na constante melhoria e evolução da integração entre o ERP e os softwares criados por parceiros nos mais variados ramos, de streaming a sistemas de mapas. A seguir, uma breve descrição de cada uma das API's e um link para sua documentação.

API Passiva

A API Passiva é usada quando o serviço oferecido é do tipo inscrição, ou seja, quando é preciso verificar se o cliente tem acesso aos serviços oferecidos pela empresa integradora. Essas requisições de autenticação e de autorização são realizadas pela Integradora e respondidas pelo ERP Voalle.

Acesse a Documentação técnica.

API PABX e Omnichannel

A sigla PABX significa "Private Automatic Brach Exchange" ou "Troca Automática de Ramais Privados". Esta API possibilita, por uma mesma linha telefônica, a conexão direta com outros linhas internas e externas sem a intervenção manual. Através das API's disponibilizadas pela Voalle, as empresas de PABX integradas com ERP, podem disponibilizar uma série de funcionalidades.

Acesse a Documentação técnica.

API Mapas - Fase 1

Integrações de mapa de Fase 1 focam em viabilidade técnica. Essa API é desenvolvida pelos prestadores de serviço de mapas integrados ao ERPVoalle, seguindo as especificações da documentação técnica citada anteriormente. Os métodos dessa API são utilizadas pelo ERPVoalle para verificar as estruturas de rede próximas ao endereço de um cliente.

Acesse a Documentação técnica.

API Mapas - Fase 2

Integrações de mapa de Fase 2 focam na equalização dos dados entre o prestador do serviço de mapa e o ERP. Os métodos dessa API são utilizados pelo integrador todas às vezes que uma alteração ou novo cadastro for feito em relação a Splitters, CTOs, Caixas de Rede e OLT.

Acesse a Documentação técnica.

API do ERP Voalle - Terceiros

As API's contidas nessa coleção permitem realizar diversas ações no ERP Voalle como:

Criar um novo Lead no CRM | Voalle;
Criar uma negociação para um novo Lead no CRM | Voalle;
Abrir uma solicitação de forma resumida;
Abrir uma solicitação detalhada;
Consultar por faturas em aberto;
Realizar a liquidação de uma fatura em aberto.

Para utilizar tais funcionalidades o usuário da autenticação deve possuir o campo Integração marcado.

Acesse a Documentação Técnica

API Portal

Verifica dados do cliente do portal de relacionamento e cria novas solicitações para ele, além de outras funcionalidades.

Acesse a Documentação técnica.

@@ Linha 1: / Linha 1: @@
 __NOTOC__
-<div align="justify">
 ==Objetivo==
 Essa página tem como objetivo reunir as documentações das API's usadas com o ERP Voalle.
@@ Linha 14: / Linha 13: @@
 Acesse a [https://documenter.getpostman.com/view/16282829/TzshHkMY Documentação técnica].
-===API PABX===
+===API PABX e Omnichannel===
 A sigla PABX significa "Private Automatic Brach Exchange" ou "Troca Automática de Ramais Privados". Esta API possibilita, por uma mesma linha telefônica, a conexão direta com outros linhas internas e externas sem a intervenção manual.
 Através das API's disponibilizadas pela Voalle, as empresas de PABX integradas com ERP, podem disponibilizar uma série de funcionalidades.
 Acesse a [https://documenter.getpostman.com/view/16282829/TzskChRy Documentação técnica].
 ===API Mapas - Fase 1===
@@ Linha 26: / Linha 25: @@
 ===API Mapas - Fase 2===
-Integrações de mapa de [[Integração de Documentação de Rede|Fase 2]] focam na equalização dos dados entre o prestador do serviço de mapa e o ERP. Os métodos dessa API são utilizados pelo integrador todas as vezes que uma alteração ou novo cadastro for feito em relação a Splitters, CTOs, Caixas de Rede e OLT.
+Integrações de mapa de [[Integração de Documentação de Rede|Fase 2]] focam na equalização dos dados entre o prestador do serviço de mapa e o ERP. Os métodos dessa API são utilizados pelo integrador todas às vezes que uma alteração ou novo cadastro for feito em relação a Splitters, CTOs, Caixas de Rede e OLT.
-Acesse a [https://documenter.getpostman.com/view/16282829/UUy4bkBZ Documentação técnica].
+Acesse a [https://documenter.getpostman.com/view/16282829/UVC3moiN Documentação técnica].
-===API do ERP Voalle - External===
+===API do ERP Voalle - Terceiros===
-As API's contidas nessa coleção permitem realizar diversas ações no ERP Voalle. Para utilizar tais funcionalidades o usuário da autenticação deve possuir o campo Integração marcado.
+As API's contidas nessa coleção permitem realizar diversas ações no ERP Voalle como:
+* Criar um novo Lead no CRM | Voalle;
+* Criar uma negociação para um novo Lead no CRM | Voalle;
+* Abrir uma solicitação de forma resumida;
+* Abrir uma solicitação detalhada;
+* Consultar por faturas em aberto;
+* Realizar a liquidação de uma fatura em aberto.
+ Para utilizar tais funcionalidades o usuário da autenticação deve possuir o campo Integração marcado.
 Acesse a [https://documenter.getpostman.com/view/16282829/TzzBqFw1 Documentação Técnica]
-===API do Solicitações (Legado)===
-As API's para integração com ERP, possibilitam trabalhar com abertura de protocolos e eventos nas estruturas de rede.
-Acesse a [https://documenter.getpostman.com/view/16282829/TzseK6bq Documentação técnica].
-===API do CRM Voalle===
-Para clientes que já estão utilizando o novo CRM - Voalle, as API's e instruções para o cadastro de Leads são apresentadas na documentação abaixo.
-Acesse a [https://documenter.getpostman.com/view/16282829/UzBguUg1 Documentação técnica].
-Também é possível realizar o cadastro de Lead e já gerar uma negociação, com os serviços que o possível cliente mostrou interesse em contratar. Essa negociação irá para a fila parametrizada no ERP e caso o lead já exista no ERP, irá atualizar seus dados cadastrais.
-Acesse a [https://documenter.getpostman.com/view/16282829/UVJeGx44 Documentação técnica].
-===API do CRM (Legado)===
-API Adiciona novo suspect no CRM. Suspect é um termo que corresponde ao provável (“suspeito”) comprador, ou seja, aquela pessoa que futuramente poderá se tornar um consumidor dos produtos e serviços oferecidos pela sua empresa.
-Acesse a [https://documenter.getpostman.com/view/7156409/SzmY9hAV?version=latest Documentação técnica].
 ===API Portal===
-Verifica dados do cliente do portal de relacionamento e cria novas solicitações para ele, além de ter outras funcionalidades.
+Verifica dados do cliente do portal de relacionamento e cria novas solicitações para ele, além de outras funcionalidades.
 Acesse a [https://documenter.getpostman.com/view/16282829/UUxwD9Yq Documentação técnica].