Como Construir suas Integrações com o Hi FLow

Sobre a função

A integração entre softwares é basicamente o processo de conectar e permitir a comunicação entre esses dois softwares, de modo que eles possam trocar informações, compartilhar dados e trabalhar em conjunto para atingir um objetivo comum.

É importante ressaltar que a integração entre softwares requer o desenvolvimento de interfaces ou APIs (Application Programming Interfaces) que permitam a comunicação entre eles. Essas interfaces definem como os softwares podem se conectar e como as informações devem ser trocadas, garantindo uma integração adequada e segura.
A partir de agora você encontrará todos os dados da nossa API.

Veja como fazer

Para trabalhar com as integrações, é recomendado criar um usuário do tipo integração. Este usuário não tem acesso a nenhuma outra função da plataforma além de executar as integrações. O endereço de e-mail utilizado deve ser válido e não pode estar presente em nenhuma outra conta na plataforma. Acesse nosso manual "Criando um Usuário na Plataforma".

Uma vez criado o Usuário, é muito importante identificar qual a integração que melhor atende sua necessidade. Por esse motivo, sugerimos que leia atentamente as orientações abaixo e, se ainda tiver alguma dúvida na escolha da melhor solução, não deixe de nos procurar.

Todas as transações devem seguir o padrão abaixo:

1. Envio de uma requisição POST para um dos endereços abaixo:

• http://app.akna.com.br/emkt/int/integracao.php

• https://app.akna.com.br/emkt/int/integracao.php

2. Inclua os seguintes campos obrigatórios:

   User=E-mail do usuário.
   Pass=Senha do usuário criptografada com MD5.
   Client = Código da empresa no sistema (solicite ao nosso atendimento. Esse campo é obrigatório caso o usuário utilizado para a integração esteja cadastrado em mais de uma canta na plataforma).
   XML=Conteúdo da Solicitação.
   Remetente = No caso de envio de SMS. Esse só é necessário se a conta possuir mais de um remetente de SMS cadastrado.

Todas as transações retornam um XML, e no caso de erro de pedido incorreto, alguns padrões de códigos de retorno são respeitados para todos os tipos de transações, são eles:

01 - Usuário e/ou senha inválidos;

02 - Permissão Negada;

03 - Transação Inválida;

04 - Usuário pertence a mais de uma empresa, obrigatório envio de código de empresa;

05 - Acesso negado;

06 - Variável do xml está sem conteúdo ou não foi informada. Verifique se a opção de encoding do seu cliente de teste API está form-data;

O XML deve ser enviado codificado em UTF-8.

Apenas os campos em negrito dos XML’s são obrigatórios.

Exemplo de configuração para utilização de um cliente para teste de API:

Não são aceitos símbolos HTML tais como " ã ç e etc. Com exceção do & nestes casos o texto deve conter a acentuação normalmente (áéãçí …).

Pontos de Atenção

1. Os XMLs contêm tanto linhas obrigatórias quanto opcionais, resultando em algumas versões distintas do mesmo XML. Se preferir, opte por exportar o documento em formato PDF, onde as linhas obrigatórias são destacadas em negrito.
2. O sistema diferencia letras maiúsculas e minúsculas, portanto, mantenha os campos User, Pass, Client e XML exatamente como mostrado aqui.
3. Lembre-se de tratar todos os XMLs de retorno. Caso ocorra algum erro, ele será descrito no XML, facilitando a identificação e correção do problema.

Exportar API em PDF

Você tem a opção de consultar nossas APIs online ou, se preferir, pode clicar para fazer o download de todas elas em formato PDF.