Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 4 Próxima »

Tópicos:

1 - URL base API

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 -> Nome da Feature -> 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.

2 - Segurança das URLs

IMPORTANTE

(aviso)    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 


3 - Endpoints

ATENÇÃO

Utilize abaixo apenas o endpoint do serviço contratado, todos os serviços necessitam de auxilio/implementação da Mobile Saúde.


FeatureEndpointMétodoDescrição

Atualização Cadastral

formulario/submit_formulario

PUT

Responsável por inserir uma nova solicitação de atualização cadastral para análise, o beneficiário envia seus dados pessoais, correções e alterações de seu cadastro e arquivos de comprovante.


FeatureEndpointMétodoDescrição

2 via de Cartã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 que deseja um novo cartão, motivo e forma de entrega, por fim os atendentes/colaboradores autorizam ou não a segunda via.


FeatureEndpointMétodoDescrição

Reembolso

reembolso/inserir

POST

Responsável por inserir uma nova solicitação de reembolso para análise, o beneficiário informa um novo reembolso que por fim os atendentes/colaborador autorizam o reembolso ou não.


4- Parâmetros


Atualização Cadastral

FeatureParâmetroObrigatórioTipoDescrição
Atualização Cadastralprotocolotrue
String

Atualização Cadastralid_operadoratrue
Inteiro

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

Atualização Cadastral

mshash

true

String

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

Atualização Cadastraltipofalse
String
Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado).
Atualização Cadastralnometrue
String

Atualização Cadastralmatriculatrue
String
Matrícula do usuário que está logado.
Atualização Cadastralmatricula_titulartrue
String
Matrícula do titular da conta.
Atualização Cadastralcampostrue
Array
Propriedade que enviará os campos do formulário.
Atualização Cadastralcampos.idtrue
Inteiro
ID do tipo de campo que será enviado.
Atualização Cadastralcampos.labeltrue
String
Label da opção preenchida ou selecionada pelo usuário.
Atualização Cadastralcampos.nametrue
String
Nome do campo que foi preenchido.
Atualização Cadastralcampos.valuetrue
String
Valor do campo preenchido pelo usuário. 


5- Exemplo de retorno API (Sucesso)


Atualização Cadastral

Retorno API sucesso
{
  "protocolo":" XYZ",
  "id_operadora" : 9999,
  "mshash" : "" ,
  "tipo" : "" ,
  "nome" : "Nome 1" ,
  "matricula" : "" ,
  "matricula_titular" : "999",
  "campos" :
  [
    {
      "id": "10",
      "label": "País",
      "name": "atualizacao_cadastral_pais",
      "value": "android test"
    },
    {
      "id": "5",
      "label": "Telefone residencial",
      "name": "atualizacao_cadastral_telefone_residencial",
      "value": "1212121"
    },
    {
      "id": "49",
      "label": "Número",
      "name": "atualizacao_cadastral_numero_2",
      "value": "android test"
    },
    {
      "id": "859"
      "label": "Comprovante de endere\u00e7o",
      "name": "atualizacao_cadastral_comprovante_de_endereco",
      "value": "https:\/\/atualizacao-cadastral.s3-sa-east-1.amazonaws.com\/969542b3-4ab6-4d54-9261-6196f2eaba5a.1616074616142.png?AWSAccessKeyId=AKIA34OGA4QDSSXFT3F4&Expires=1616076000&Signature=6bH3weEUx5otIY49asdxY%2BN%2Bw0%3D",    
    }
  ]
}

6- Exemplo de retorno API (Erro)

Retorno API falha
{
    "error": "Erro: Cliente não encontrado.",
    "code": 0,
    "status": false
}



ATENÇÃO

Esse endpoint não possui retorno de erro mesmo enviando dados inválidos ele retorna como se não tivesse registro.Padrões documentação API


  • Sem rótulos