Skip to main content

API de Integração com EPA Ouvidoria

API de Integração – EPA-Ouvidoria

O EPA está preparado para receber requisições HTTP via método POST para a criação de novos registros de atendimento na ferramenta de Ouvidoria. Abaixo constam as especificações técnicas da estrutura de envio e de retorno.

1. Estrutura da Requisição (Envio)​

  • Método HTTP: POST
  • URL: URL de destino do ambiente do cliente (ex: https://cliente.sysepa.com.br/epa/srvepa.php)

Parâmetros do Corpo (Payload)​

ParâmetroTipoObrigatoriedadeDescrição
tokenstringObrigatórioCódigo único para cada cliente. Deve ser solicitado à equipe de desenvolvimento da Simeon.
opcaostringObrigatórioFixar o valor como "RegistrarAtendimento".
atendimentoobjectObrigatórioObjeto contendo os dados detalhados do atendimento (veja abaixo).

Campos do Objeto atendimento​

  • nome (string): Nome do solicitante.
  • telefone (string): Telefone de contato.
  • email (string): E-mail de contato.
  • descricao (string): Descrição/relato da manifestação.
  • assunto (string) — Obrigatório: Código do assunto correspondente no sistema do cliente, criado especificamente para identificar registros inseridos via API.
  • tipo (string) — Obrigatório: Código do tipo de atendimento correspondente no sistema do cliente.
  • unidade (string) — Obrigatório: Identificador do setor. Fixar o valor como "Ouvidoria".
  • UnidadeModeradora (string): Setor responsável pela moderação. Fixar o valor como "Ouvidoria".

2. Exemplos de Implementação​

Exemplo em JSON​

{
  "token": "XXXXXXXXX",
  "opcao": "RegistrarAtendimento",
  "atendimento": {
    "nome": "XXXXXX",
    "telefone": "XXXXX",
    "email": "XXX@XXXX",
    "descricao": "XXXXXXX",
    "assunto": "XXX",
    "unidade": "Ouvidoria",
    "tipo": "XXXX",
    "UnidadeModeradora": "Ouvidoria"
  }
}

Exemplo de Implementação em JavaScript (jQuery)​

<head>
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
</head>
<body>
<script>
$(document).ready(function(){
    $.ajax({
        url: 'https://cliente.sysepa.com.br/epa/srvepa.php',
        type: "POST",
        method: "POST",
        dataType: "json",
        data: {
            token: "55fff11739632fec4f630748e1c",
            opcao: "RegistrarAtendimento",
            atendimento: {
                nome: "nometeste",
                telefone: "88441234",
                email: "teste@hotmail.com",
                descricao: "conteudo da mensagem",
                assunto: "2",
                tipo: "5",
                unidade: "Ouvidoria",
                UnidadeModeradora: "Ouvidoria"
            }
        }
    }).done(function(response){
        console.log(response); // JSON com o retorno, incluindo o código gerado pelo sistema
    }).fail(function(response){
        console.log(response);
    });
});
</script>
</body>

3. Estrutura da Resposta (Retorno)​

Sucesso​

Retorna o código identificador gerado e ecoa os dados enviados.

{
  "Atendimento": "99999",
  "Mensagem": "Atendimento registrado com sucesso!",
  "conteudo": {
    "nome": "nometeste",
    "telefone": "88441234",
    "email": "teste@hotmail.com",
    "descricao": "conteudo da mensagem"
  }
}

  • Atendimento: Código do atendimento registrado internamente no EPA.
  • conteudo: Objeto contendo nome, telefone, email e descricao digitados na origem.

Falha​

Retorna um código de status de erro e a descrição do problema.

{
  "statusCode": "9",
  "message": "Mensagem de erro correspondente"
}

Falhas Previstas:​

  • 1: Nome não informado.
  • 2: Telefone não informado.
  • 3: Email não informado.
  • 4: Não foi possível registrar no banco de dados.

4. Regras de Negócio e Parametrização Importantes​

⚠️ Vínculo de Cadastro (Campo Chave) O parâmetro “Definir o campo chave que será utilizado no formulário externo da Ouvidoria” dentro do EPA é o responsável por determinar qual critério o sistema utilizará para localizar ou criar o cadastro da pessoa e vinculá-lo ao atendimento. Dependendo da configuração ativa no EPA, a requisição deve conter obrigatoriamente o campo correspondente indicado abaixo:

  • Se configurado como “Matrícula/Número do Cartão”: A requisição deve conter o campo matricula.
  • Se configurado como “CNPJ/CPF”: A requisição deve conter o campo cpf_cnpj.
  • Se configurado como “E-mail”: A requisição deve conter o campo email. ...

Banner Gigi