User Tools

Site Tools


br-122-api-chck


Solicitação API / CHCK

O comando CHCK solicita ao webservice, por meio de POST, a verificação de usuários e respectivos códigos de assinatura.



Variáveis POST

id Código de identificação do canal solicitante, sem criptografia (Channel-ID)
key Chave AES (temporária), criptografada com a chave pública do canal e codificada em Base64 / URL Encode.
frame String criptografado com a chave AES (temporária), contendo o XML de solicitação (comando, número de sequência da solicitação e parâmetros), e codificado em Base64 / URL Encode.



XML de resposta do POST

Após o processamento da solicitação contida no POST, o webservice retorna o seguinte XML para o solicitante:

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<retcode>código-de-retorno</retcode>
<retframe>xml-de-resposta-da-solicitação</retframe>
<retmd5>md5-de-resposta</retmd5>
</followzup>

Onde:

  • código-de-retorno: String não criptografado, contendo o valor “0” (zero) para as solicitações executadas com sucesso, ou o código de erro correspondente, composto por 4 dígitos numéricos.
  • xml-de-resposta-da-solicitação: String criptografado com a mesma chave AES utilizada no envio da solicitação (chave temporária), e codificado em Base64.
  • md5-de-resposta: String contendo o hash md5 do campo acima.



XML de solicitação

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<com>chck</com>
<seq>sequência-da-solicitação</seq>
<urs>identificação-do-usuário</urs>
<sub>subscription-code</sub>
</followzup>

onde:

  • Literal chck: Comando para verificação de usuário (Check User);
  • sequência-da-solicitação: Número de sequência da solicitação;
  • identificação-do-usuário: E-mail ou User-ID do usuário a ser verificado;
  • subscription-code: Código da assinatura do canal a ser verificada.



XML de resposta da solicitação

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<uid>USER-ID</uid>
<reg>yes|no</reg>
</followzup>

onde:

  • USER-ID: Código do usuário verificado;
  • yes|no: Flag YES = usuário registrado, NO = usuário anônimo.


XML de resposta da solicitação (sequência inválida):

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<seq>Last-sequence</seq>
</followzup>

Onde:

  • Last-sequence: Número de sequência utilizado na última solicitação.



Códigos de Retorno

0 Execução com sucesso
6101 Sequência inválida (deve ser tratado pela API)
6102 Frame inválido
6103 Comando inválido
6104 Channel-ID inválido
6106 Usuário inválido
6203 Usuário informado não é assinante do canal
6204 Código da assinatura informada não confere
6999 Webservice em manutenção


br-122-api-chck.txt · Last modified: 2017/03/08 08:58 by admin

Page Tools