Carregando...

Integrando a Plataforma com um Software Externo

Primeiros Passos

 

As integrações servem para "ligar" um site ou algum outro software, como por exemplo um CRM, utilizado em sua empresa com a plataforma Akna.

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:

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

Com 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.

Atenção: O sistema faz diferenciação entre letras maiúsculas e minúsculas, portanto mantenha User, Pass, Client e XML exatamente como escrito aqui.

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.
  • Se estiver utilizando algum cliente de teste de API , como por exemplo postman, a opção de codificação marcada deve ser form-data.

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 (áéãçí …).

Lembre-se de tratar todos os XML de retorno, pois caso ocorra algum erro será descrito no mesmo e será muito mais fácil identificar o problema e corrigir.

Este conteúdo foi útil?68