Suporte / Ajuda

Pesquise sua dúvida diretamente abaixo ou busque nos tópicos frequentes.

Leitores

API Cadastro de Usuários

Introdução

Essa API permite cadastrar um novo usuário leitor e diversos outros campos de dados customizados, além de permitir resetar a senha de um usuário e logá-lo e deslogá-lo da plataforma Magtab. Seguimos os padrões de design RESTfulCrud e JSON API.

O acesso a API somente estará disponível usando o protocolo HTTPS, sendo a URL base desta api:
https://api.magtab.com/api/appv2

Todos os dados deverão ser enviados e retornados em formato válido JSON.

Disponibilizamos um exemplo de um formulário completo, este é o mesmo que o App mostra para cadastros customizados:

Baixar: exemplo de formulário de cadastro em JavaScript.

Autenticação

Para autenticação é necessário anexar na chamada via POST ou GET uma chave única que será fornecida caso solicitada via o email sac@magtab.com

Campos de cadastro disponíveis

Para cadastrar um novo usuário, a API precisa de ao menos um campo de cadastro extra, portanto além dos campos obrigatórios: usuário, nome, sobrenome e senha, existem outros campos opcionais como telefone, endereço, cidade, sexo, etc.

Esses campos são adicionados a um App sob demanda, e apenas um é listado por padrão, o Telefone.

Utilize este endpoint para consultar quais campos extra seu App possui. Salve os “resource_uri” de cada campo que desenha adicionar a um cadastro posteriormente.

Resource URL

GET  https://api.magtab.com/api/appv2/cadastrotitulocampos

Parametros

api_key:obrigatório

Body não utilizado.

Exemplo de retorno

HTTP Response:202 ACCEPTED

{
 "cadastrotitulocampos": [{
     "campo": {
     "tipo": "text",
     "exemplo": "",
     "nome": "Telefone",
     "mascara": "(XX) XXXXX XXXX",
     "resource_uri": "/api/appv2/cadastrocampos/11/"
 },
 "titulo": "/api/cadastrov1/titulo/xxx/",
 "obrigatorio": false,
 "ordem": 0,
 "resource_uri": "/api/appv2/cadastrotitulocampos/xxx/"
 }]
}

Cadastrando usuários

Cada campo deve ser adicionado em um novo dicionário dentro do array de usuários. Após cadastrada a senha, nome e sobrenome em um dos campos, os campos subsequentes não precisam dessas informações, apenas o email.

Resource URL

PATCH  https://api.magtab.com/api/appv2/cadastrousuarios

Parametros

api_key:obrigatório

Body
{
    "cadastrousuarios":
    [
        {
            "usuario":"seuleitor@email.com",
            "senha":"Senh@",
            "nome":"Seu",
            "sobrenome":"Leitor",
            "campo":"/api/appv2/cadastrocampos/11/",
            "valor":"0099990000"
        }
    ]
}

Exemplo uso

curl -X POST "https://api.magtab.com/api/appv2/cadastrousuarios/?api_key=03425d44943ffc5ac843c2b6c0b771d4ef57952f" \
-d '{"cadastrousuarios":[{"usuario":"seuleitor@email.com","senha":"Senh@","nome":"Seu","sobrenome":"Leitor","campo":"/api/appv2/cadastrocampos/11/","valor":"0099990000"}]}' \ -H "Content-Type: application/json"

Exemplo de retorno

HTTP Response:202 ACCEPTED

{
 "objects": [{
   "usuario": "seuleitor@email.com",
   "nome": "Seu",
   "sobrenome": "Leitor",
   "senha": null,
   "campo": "/api/appv2/cadastrocampos/11/",
   "valor": "0099990000",
   "resource_uri": "/api/appv2/cadastrousuario/xxx/"
 }]
}

Login

Para o login, apenas o email (username) e senha (password) serão necessários. A API retorna 202 no sucesso e uma chave de sessão (key) que deve ser salva e utilizada para validar operações relacionadas a este usuário logado.

Resource URL

POST https://api.magtab.com/api/appv2/auth/login/

Parametros

api_key:obrigatório

Body
{
 "username":"seuleitor@email.com",
 "password":"Senh@"
}

Exemplo retorno

HTTP Response:202 ACCEPTED

{
 "device": "",
 "user": {
     "key": "XXX",
     "name": "Seu",
     "type": [
         "leitor"
     ],
     "restrict": false
 }
}

Logout

Para o logout, passe apenas a chave de sessão salva anteriormente (key) como “session_key” em um dict.

Resource URL

POST https://api.magtab.com/api/appv2/auth/logout/

Parametros

api_key:obrigatório

Body
{
 "session_key":"seuleitor@email.com"
}

Exemplo retorno

HTTP Response:202 ACCEPTED

{
 "success": true,
 "device": ""
}

Reset de senha

Para solicitar uma nova senha para um usuário é necessário apenas informar o email do mesmo.

Resource URL

POST https://api.magtab.com/api/appv2/auth/reset/

Parametros

api_key:obrigatório

Body
{
 "username":"seuleitor@email.com"
}

Exemplo retorno

HTTP Response:202 ACCEPTED

{
 "success": true
}

Assinaturas

Após criar um usuário, é necessário adicionado-lo a base de assinantes.

O controle de assinantes utiliza uma API diferente no momento, e sua documentação está em:
https://magtab.com/ajuda/api-de-controle-de-assinatura-externa/

Ferramentas de auxílio ao desenvolvedor

Curl

Plugin restClient para Firefox

Não encontrou o
que procurava?

Converse conosco para receber uma resposta
personalizada ou para obter assistência.

Quero saber mais sobre...

Leitores