Instituto MESC

Sobre essa API

Essa API é utilizada para implementar uma pesquisa através de um iframe independente no site site ou portal do cliente.

Com essa API, você consegue fazer um embed de um iframe de uma pesquisa diretamente no seu portal. É possível ainda customizar o layout para integrar a identidade visual do site com uso de templates customizados.

Essa API do MESC é utilizada para facilitar a implementação de uma pesquisa em seu site ou portal do cliente. Simplismente você consegue fazer um embed de um iframe de uma pesquisa diretamente no seu portal. É possível ainda customizar o layout para adequa-lo ao seu site.

Método utilizado:

GET

Parâmetros:

token: é o token do recurso gerado diretamente no MESC360
id: é o hash único do cliente registrado no MESC.

Exemplo de URL:

https://api.mesc.cx/2.0/api-MESC-widget?token={token}&id={id}

{token} é uma chave criptografada de 64 bits, gerada dentro do MESC360 para liberar o acesso ao recurso.
Onde {id} é o id único de identificação do cliente dentro do MESC.

Exemplo de retorno

Ambos os casos status 200.

Sucesso: em caso de sucesso, será retornado o código html do iframe que será embedado na página.
Insucesso: será retornado um Json com a seguinte estrutura:

                            
"description" : "Parâmetros incorretos",
"schema" : {
    "type" : "string",
    "example" : "Token inválido para esse recurso;
                Esse cliente já respondeu a pesquisa (caso esteja inelegível para responder a pesquisa);
                ID inválido, caso o Token do cliente seja inválido"
}

Filename : api-MESC-Widget

Customizações Disponíveis

Template: Customize com um template que se adéque ao seu layout;
Destino: Customize a página de destino após a resposta da pesquisa;
Quarentena: Mostre a pesquisa somente a clientes elegíveis.

Exemplos de SDKs (S):

Acesse o MESC360 no menu direito consulte: APIs -> Documentações, lá você vai enconrar exemplos de códigos e como você pode testar o consumo dessa API.

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.

API Widget