API de Integração com EPA-Ouvidoria

O EPA está preparado para receber um POST de uma URL a ser gravado como um novo registro de atendimento na ferramenta de ouvidoria.

Abaixo segue a descrição da estrutura da string de envio e de retorno.

 

STRING DE ENVIO

-URL=URL do EPA

-Método=POST

-Parâmetros:

 token: string,

opcao: string,

atendimento: objeto [nome:string, telefone:string, email:string, descricao:string, assunto:string, unidade:string, tipo:string, UnidadeModeradora:string]

 

PARÂMETROS A SEREM MANTIDOS COMO OBRIGATÓRIOS:

token: Solicitar à equipe de desenvolvimento da Simeon. É um código único para cada cliente.

opção: “RegistrarAtendimento“

assunto: Código do assunto existente no cliente criado especificamente para identificar os registros inseridos pela API

tipo: Código do tipo de atendimento existente no cliente

unidade: “Ouvidoria”

 

Exemplo em JSON

JSON:

{ “token”: “XXXXXXXXX”,

   “opcao”:”RegistrarAtendimento”,

   “atendimento”: { “nome”: “XXXXXX”,  “telefone” : “XXXXX”, “email” : “XXX@XXXX”, “descrição” : “XXXXXXX”, assunto:”XXX”, unidade:”Ouvidoria”, tipo:”XXXX”, UnidadeModeradora:”Ouvidoria”}

}

 

Exemplo de implementação em JavaScript

<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, inclusive codigo gerado pelo sistema

}).fail(function(response){

console.log(response);

})

})

</script>

</body>

 

 

STRING DE RETORNO

Sucesso:{“Atendimento:99999”,”Atendimento registrado com sucesso!”, conteudo(nome, telefone, email, descricao)}

Sendo:

Atendimento: código do atendimento registrado no EPA;

conteúdo: nome, telefone, email e descrição: conteúdo dos campos digitado no site.

Falha:

{“statusCode:9”,mensagem de erro}

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.