Autenticando o servidor da API
Autenticando o servidor da API
Para usar o componente euAtendo, é necessário definir o servidor URL e a GlobalAPI antes de utilizar as funções. Esses valores podem ser fixados no seu código, pois geralmente não mudam.Caso ainda não possua um servidor privado, você pode testar utilizando o servidor COMUNITÁRIO DISPONÍVEL:
- ApiGlobal: ASD3F21APIDEVS6A5SPAULOJRDEVFA1
- endPoint: https://apiv1demo.apidevs.app
- Manager: https://apiv1demo.apidevs.app/manager
Instâncias 'Celulares de Clientes'
Instâncias 'Celulares de Clientes'
Cada instância representa um dispositivo conectado (por exemplo, o celular de um cliente). Pode ser utilizado para uma única empresa ou para diferentes empresas.Sempre que uma instância é criada, é obrigatório salvar o nome e a senha da instância para uso futuro. Dessa forma, sempre que o ERP for inicializado, os valores serão passados ao componente durante a sua inicialização.Antes de chamar a função CriarInstancia, é necessário passar dois parâmetros ao componente:A criação de uma instância pode ser feita da seguinte forma:Após chamar a função para criar a instância, é necessário implementar o evento que será disparado com as informações da instância recém-criada:Assim, após a criação da instância, os dados retornados (nome, status, chave API) são armazenados e usados para futuras conexões.
Conectar em uma instancia existente
Conectar em uma instancia existente
Uma vez que a instancia é criada, voce deve armazenar os dados dela, e usar esses dados sempre que for necessario.
Passo a Passo para utilizar e alternar instancias
- Recupere o nome e a chave API da instância previamente salvos..
- Passe os valores ao componente.
- Tente conectar à instância utilizando a função StatusInstancia.
Passe os parametros para o componente
Resultado Esperado
Após a execução bem-sucedida dessa função, o componente estará conectado à instância especificada. Caso ocorra algum erro durante a tentativa de conexão, uma mensagem será exibida com detalhes do erro.Consultar Status da Instância
Consultar Status da Instância
Para consultar o status de uma instância já criada, você pode utilizar a função ApiEuAtendo1.StatusInstancia(). Após chamar essa função, o evento OnStatusInstancia será disparado, retornando as informações de status da instância.
Passo a Passo para Consultar o Status
- Chame a função StatusInstancia para consultar o status da instância.
- O evento OnStatusInstancia será disparado com o retorno do status da instância.
- Utilize os valores retornados para atualizar os campos ou interface conforme necessário.
Chame a função
Retorno no componente
Resultado Esperado
Após chamar a função StatusInstancia, o evento OnStatusInstancia será disparado automaticamente, retornando informações como o nome da instância e o estado atual. Essas informações podem ser utilizadas para atualizar a interface ou tomar ações com base no status da instância.Possíveis Estados de Instância
O valorInstanceStatus.State
retornará o estado atual da instância, que pode ser utilizado para monitorar se a instância está conectada, desconectada, ou em outro estado.Exemplos de estados:- Open
- Closed
- Connecting
Tratamento de Erros
Caso haja algum problema na consulta do status, certifique-se de que a instância está corretamente configurada e ativa.Listar Todas as Instâncias
Listar Todas as Instâncias
Para listar todas as instâncias conectadas, utilize o método ApiEuAtendo1.ObterInstancias. Quando essa função é chamada, o evento OnObterInstancias será disparado, retornando uma lista de todas as instâncias disponíveis.
Passo a Passo para Listar as Instâncias
- Chame o método ObterInstancias para recuperar a lista de instâncias.
- O evento OnObterInstancias será disparado, retornando as informações de cada instância.
- Utilize essas informações para exibir as instâncias, como nome, chave API e número de telefone, de acordo com a versão do componente.
Chame usando esse metodo
implemente o evento do componente OnObterInstancias
Resultado Esperado
Após chamar o método ObterInstancias, o evento OnObterInstancias será disparado, retornando uma lista de instâncias. As informações retornadas variam de acordo com a versão do componente (V1 ou V2), e incluem o nome da instância, a chave API, e o número de telefone associado à instância.- Para a versão V1, a propriedade
Owner
contém o número de telefone. - Para a versão V2, a propriedade
PhoneNumber
contém o número de telefone.