API para Consultar Regras

Sobre essa API

Essa API é utilizada para consultar se um cliente está elegível para responder uma pesquisa de acordo com as regras estabelecidas.

As regras podem ser:

1. Quarentena: Número de dias que o cliente fica inelegível após responder uma pesquisa.

2. Quantidade de visualizações: No MESC é possível determinar o número de vezes que um cliente visualiza um questionário de pesquisa sem responde-lo. Digamos que você tenha um questionário de pesquisa em seu APP e queira que esse questionário seja apresentado somente a cliente elegíveis a pesquisa. No entanto, você pode determinar o número de vezes que esse questionário aparece para o cliente.

3. Quantidade de dias para zerar as regras de visualizações: Representa o número de dias que o cliente fina inelegível a pesquisa pelo fato de ter visualizado muitas vezes um questionário sem optar por respondê-lo. Você pode determinar o número de dias em que o cliente fica sem ver o questionário e depois desse período, volta a visualizar.

4) Blacklist: No MESC existe o conceito de blacklist, ou seja, você pode determinar que um cliente não está elegível a responder uma pesquisa. Exemplo: Quando o cliente está com um reclamação formal; Quando o cliente está em processo de desmobilização; Quando o cliente clicou em opt-out numa peça de e-mail

Método utilizado:

• GET

Parâmetros:

• token: é o token do recurso gerado diretamente no MESC360
• id: é o hash único do cliente registrado no MESC.
• addView: é um Bollean para adicionar uma visualização na regra.

Exemplo de URL:

• https://api.mesc.cx/2.0/api-MESC-regras

Exemplo de retorno

Ambos os casos status 200. Uma resposta Json.

• Sucesso ou Insucesso: será retornado um Json com a seguinte estrutura:

                            
{
    'return'                    => "String",
    'blackList'                 => "Bollean",
    'RegraVezesVisualizacao'    => "Int",
    'RegraDiasVisualizacao'     => "Int",
    'RegraDiasQuarentena'       => "Int",
    'visualizacao'              => "Int",
    'log'                       => "Date",
    'hash'                      => "String",
    'RegraDescanso'             => "String",
}
                        

Filename : api-MESC-regras

Detalhamento dos parâmetros

• return: inelegivel
• blackList: null (caso o cliente não esteja em regra de quarentena)
• RegraVezesVisualizacao: 10 (representa o número de vezes que a regra de visualização está configurada)
• RegraDiasVisualizacao: 7 (representa o número de dias em que a regra de visualização de um cliente será zerada)
• visualizacao: 0 (representa o número de vezes que um cliente visualizou um questionário de pesquisa no seu site ou app via widget)
• log: 2023-05-12 16:18:29 (representa a data e hora que o cliente respondeu a pesquisa, caso esteja elegível esse campo retorna vazio)
• hash: {hash de 64 bits} (trata-se de uma assinatura digital da consulta podendo ser configurada para validar respostas de clientes somente que tem assinatura digital disponível)
• RegraDescanso: {string} (Caso o cliente esteja em regra de descanso, aparecerá como inelegível e nessa chave o motivo)

Customizações Disponíveis

• Personalização de Saída: Customize o formato e as mensagens de saída que deseja receber;
• Informações Adicionais: Customize a informação adicional que deseja receber na consulta de regras de um cliente;

Exemplos de SDKs (S):

Acesse o MESC360 no menu direito consulte: APIs -> Documentações

• Curl
• Java
• Android
• JavaScript
• C#
• PHP
• Perl
• Phyton

Volumetria

A volumetria padrão para essa APIs está setada para 1 milhão de acessos por mês. Caso sua empresa tenha uma previsão de consumo maior, fale com seu ponto focal para detalhes do ambiente API dedicado MESC.

Segurança

Para liberação de acesso e uso é necessário informar o range de IPs dos servidores que farão o consumo dessa API.