Versões comparadas

Versão antiga 10

changes.mady.by.user Bruno Vieira (Unlicensed)

Gravado em

comparado com

Nova versão 11

changes.mady.by.user Ranniêr Reis

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Tópicos:

Índice

URL base API

AmbientesURL
Homologaçãohttps://ms3.tapcore.com.br/mssuite/plataforma_beneficiario
Produçãohttps://ms3.tapcore.com.br/mssuite/plataforma_beneficiario

Como configurar a URL de Callback

Acesse o seu painel administrativo em: painel.tapcore.com.br e no menu lateral busque a funcionalidade:

Beneficiário -> Solicitações de Cartão -> Configuração

Preencha o campo: URL de Callback com a URL que receberá a requisição de callback após inserção de uma nova solicitação de cartão.


Endpoint

EndpointMétodoDescrição

solicitacao/solicitacao_cartao

PUT

Responsável por inserir uma nova solicitação de segunda via de cartão para análise, o beneficiário informa os beneficiários que desejam novos cartões, motivo e forma de entrega, por fim os administradores autorizam ou não a segunda via.


Parâmetros

ParâmetroObrigatórioTipoDescrição
protocolotrue


Cor do plano de fundo
color#EDEEF1
String



mshash

true


Cor do plano de fundo
color#EDEEF1
idtipo
String


HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

id_solicitacao_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Int



id_operadoratrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro


Id da operadora para a qual serão buscados os grupos de menu

id_aplicacaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



id_status_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



id_motivo_solic_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



id_forma_entrega_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



nome_titulartrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



cpf_titulartrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



matricula_titulartrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



telefone_titulartrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



estado_civil_titulartrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



email_titulartrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



patrocinadora_titularfalse


Cor do plano de fundo
color#EDEEF1
idtipo
String



descricaofalse


Cor do plano de fundo
color#EDEEF1
idtipo
String



protocolotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



datatrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



forma_entregatrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



motivotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



arquivostrue


Cor do plano de fundo
color#EDEEF1
idtipo

Array



arquivos.id_arquivotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



arquivos.nometrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



arquivos.diretoriotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



arquivos.urltrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



arquivos.id_solicitacao_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



beneficiariostrue


Cor do plano de fundo
color#EDEEF1
idtipo
Array



beneficiarios.id_beneficiario_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



beneficiarios.nometrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



beneficiarios.matriculatrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



beneficiarios.parentescotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



beneficiarios.data_nascimentotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



beneficiarios.id_solicitacao_cartaotrue


Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro



endereco_alternativofalse


Cor do plano de fundo
color#EDEEF1
idtipo
String



statustrue


Cor do plano de fundo
color#EDEEF1
idtipo
String




Parâmetros

O callback será feito através de uma requisição HTTP do tipo POST ao serviço cadastrado, os parâmetros serão enviados via RAW no formato JSON, conforme as especificações abaixo:

Bloco de código
languagejs
themeMidnight
titleParâmetros da Requisição
linenumberstrue
{
    "protocolo" : "xyz123",
    "mshash" : "",
    "id_solicitacao_cartao": 999,
    "id_operadora": 99,
    "id_aplicacao": 7,
    "id_status_cartao": 1,
    "id_motivo_solic_cartao": 6,
    "id_forma_entrega_cartao": 3,
    "nome_titular": "Nome de teste",
    "cpf_titular": 12121166742,
    "matricula_titular": "000100020003",
    "telefone_titular": 27000666898,
    "estado_civil_titular": "Solteiro",
    "email_titular": "teste@gmail.com",
    "patrocinadora_titular": null,
    "descricao": null,
    "protocolo": "3139042017080200355",
    "data": "2017-08-02 13:34:38",
    "forma_entrega": "Entregar ao Titular pelos correios",
    "motivo": "Perda",
    "arquivos": [{
        "id_arquivo": 59,
        "nome": "c094be33c587e163ee702662491cd1a55ca6f854f.pdf",
        "diretorio": null,
        "url": https://s3-sa-east-1.amazonaws.com/solicitacao-cartao-ms/teste.pdf,
        "id_solicitacao_cartao": 117
    }],
    "beneficiarios": [{
        "id_beneficiario_cartao": 133,
        "nome": "Teste Romano Teste Rizzi",
        "matricula": "000100020003",
        "parentesco": "Titular",
        "data_nascimento": "1991-02-23",
        "id_solicitacao_cartao": 117
    }],
    "endereco_alternativo": null,
    "status": "Solicitado"
}

Retornos de sucesso Callback - Segunda Via de Cartão

Bloco de código
languagejs
themeMidnight
titleRetorno de alteração de status
linenumberstrue
{
    "protocolo" : "3139042017080113117" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "id_status_cartao" : "2"
}


Nota
titleATENÇÃO
Todo callback executado, que tenha como retorno status header 200 será considerado uma conexão de sucesso, independente do seu retorno.
É possível também alterar o status de uma solicitação de atualização cadastral, basta que o serviço de integração retorne em seu body um json no padrão abaixo.