Comparação de Páginas

Índice

Dica
Só são suportadas integrações no padrão REST.

Introdução

Aprimorando a experiência do atendimento, implementamos uma funcionalidade em nosso painel que permite aos atendentes realizar novos atendimentos a partir de diversas fontes externas, como telefone e WhatsApp. Para otimizar esse processo, desenvolvemos uma API que possibilita a integração do cliente com nosso painel do atendente. Agora, ao preencher o formulário de "novo atendimento", o atendente informa o canal de contato (por exemplo, WhatsApp), e nossa API coleta as informações inseridas para que a API do cliente retorne dinamicamente os dados do usuário. Esse recurso visa facilitar a identificação do beneficiário em nossa plataforma, promovendo uma gestão eficiente e personalizada dos atendimentos.

Método "busca beneficiarios”

Informações
Atente-se aos critérios de preenchimento; Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ buscaBeneficiarios

Nota

Atenção

O endpoint obrigatoriamente deve terminar com “/buscaBeneficiarios”.

POST

application/json

Endpoint lista os beneficiários agrupados por contrato.

Parâmetros de entrada

Informações
Formulário dinâmico criado pelo Formbuilder. A aplicação fica responsável por encaminhar o formulário informado para o método de primeiro acesso. Os parâmetros de entrada devem ser devidamente informados no formulário de autenticação utilizado configurador de integração.

Descrição dos objetos e atributos de retorno - Sucesso

Serão enviados no BODY os seguintes parâmetros:

...

Bloco de código

language	json

{
  "coluna": [
    {
      "id": "nome",
      "descricao": "Nome"
    },
    {
      "id": "data_nascimento",
      "descricao": "Nasc."
    },
    {
      "id": "registro_geral",
      "descricao": "RG"
    },
    {
      "id": "id_matricula",
      "descricao": "Matricula"
    },
    {
      "id": "nome_mae",
      "descricao": "Nome da Mãe"
    }
  ],
  "beneficiarios": [
    {
      "nome": "João Pedro",
      "data_nascimento": "05/08/1994",
      "registro_geral": "3025-517",
      "id_matricula": "123-123-321",
      "nome_mae": "Maria Delmaschio",
      "chaveUnica": "15846772777"
    },
    {
      "nome": "João Pedro",
      "data_nascimento": "05/08/1994",
      "registro_geral": "3025-517",
      "id_matricula": "123-123-321",
      "nome_mae": "Maria Delmaschio",
      "chaveUnica": "15846772777"
    },
    {
      "nome": "João Pedro",
      "data_nascimento": "05/08/1994",
      "registro_geral": "3025-517",
      "id_matricula": "123-123-321",
      "nome_mae": "Maria Delmaschio",
      "chaveUnica": "15846772777"
    }
  ]
}

Retorno da API - Falha

Nota
Atente-se as mensagens de retorno para cada HTTPS Status Code; Para que a mensagem de falha seja exibida, é necessário devolver um STATUS CODE diferente de 200 (OK). Recomendamos usar o STATUS CODE do grupo 400.

Objetos e atributos de retorno

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

status

M

String

Devolva False quando desejar exibir a mensagem de erro.

mensagem

M

String

Utilize esse atributo para escrever a mensagem que será exibida para o usuário do app.

Texto livre. Indique uma mensagem de erro que forneça orientações ao usuário do app.

Exemplo: “Usuário ou senha inválidos”.

Informações
Entenda que mensagens de erros muito detalhadas podem ajudar muito seu usuário final na localização de um problema no ato do login. Porém, se a mensagem for muito esclarecedora, pode facilitar também a ação de hackers. Mensagens como “Usuário/senha inválidos” conseguem ajudar o usuário, sem revelar QUAL dos 2 está errado.

Exemplo retorno API - falha

Bloco de código
{ "status": "false", "mensagem": "Login ou senha inválidos" }

...

Versões comparadas

Versão antiga 1

Nova versão 2

Chave