Solicitação Segunda Via do Cartão

Tópicos:

URL base API

Ambientes	URL
Homologação	https://ms3.tapcore.com.br/mssuite/plataforma_beneficiario
Produção	https://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.

Segurança das URLs

Importante

Todas as imagens que estão sob nosso domínio não são disponibilizadas de forma pública, favor seguir as recomendações abaixo!

Por questões de segurança todas as imagens ou objetos disponíveis através de uma URL serão enviadas com uma assinatura, desta forma, o download dos objetos ou imagens disponíveis, só serão possíveis por um período de aproximadamente 15 minutos.

Recomenda-se que seja feito o download da imagem ou objeto assinado assim que receber este payload e não salve a URL pois ela ficará indisponível após o tempo pré-determinado.

Em casos que seja necessário o acesso a este objeto ou imagem depois desse período, re-envie o callback através do painel para receber uma nova assinatura válida por mais 15 minutos

Exemplo da url ->https://autorizacao.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD

Parâmetros

Endpoint

Endpoint	Método	Descriçã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âmetro	Obrigatório	Tipo	Descrição
protocolo	true	String
mshash	true	String	HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.
id_solicitacao_cartao	true	Int
id_operadora	true	Inteiro	Id da operadora para a qual serão buscados os grupos de menu
id_aplicacao	true	Inteiro
id_status_cartao	true	Inteiro
id_motivo_solic_cartao	true	Inteiro
id_forma_entrega_cartao	true	Inteiro
nome_titular	true	String
cpf_titular	true	Inteiro
matricula_titular	true	String
telefone_titular	true	Inteiro
estado_civil_titular	true	String
email_titular	true	String
patrocinadora_titular	false	String
descricao	false	String
protocolo	true	String
data	true	String
forma_entrega	true	String
motivo	true	String
arquivos	true	Array
arquivos.id_arquivo	true	Inteiro
arquivos.nome	true	String
arquivos.diretorio	true	String
arquivos.url	true	String
arquivos.id_solicitacao_cartao	true	String
beneficiarios	true	Array
beneficiarios.id_beneficiario_cartao	true	Inteiro
beneficiarios.nome	true	String
beneficiarios.matricula	true	String
beneficiarios.parentesco	true	String
beneficiarios.data_nascimento	true	String
beneficiarios.id_solicitacao_cartao	true	Inteiro
endereco_alternativo	false	String
status	true	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:

Parâmetros da Requisição

{
    "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/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD,
        "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

Retorno de alteração de status

{
    "protocolo" : "3139042017080113117" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "id_status_cartao" : "2"
}

ATENÇÃ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.