Prévia do material em texto

Manual de Utilização da API 
 
Chave de acesso. 
A chave de acesso única do fornecedor (necessária para qualquer transição entre nossas API’s), 
é liberada após a conclusão do cadastro RFID da Empresa. 
 
Caso esteja com o cadastro incompleto é necessário seguir o passo a passo disponível na tela 
inicial do Portal RFID para adequação. 
 
Após o cadastro ser concluído, a chave pode ser consultada em “Configurações RFID” 
localizado no menu principal do portal. 
 
 
 
 
 
 
Geração de EPC’s associados. 
Gera códigos EPC’s já associados. 
 
Url da EndPoint de acesso: 
https://cliente.havan.com.br/PortalRfid/Api/GerarEpc/ 
 
Envio para API 
Para o Envio será necessário um JSON no seguinte Formato: 
 
Em relação aos Campos: 
 Chave de Acesso: 
o Tipo: “String”; 
o Detalhe: 
Chave de Acesso única do Fornecedor. Pode ser consultada no Portal RFID na 
opção “Configurações Rfid” do Menu; 
 BarCode: 
o Tipo: “String”; 
o Detalhe: 
Código de barras do Produto a ser gerado o EPC; 
 Imei: 
o Tipo: “String”; 
o Detalhe: 
Número do Imei do produto; 
Será feita verificação se o Número do Imei já existe no Nosso cadastro; 
 
 
https://cliente.havan.com.br/PortalRfid/Api/GerarEpc/
Retorno da API 
O retorno da API será um JSON no seguinte formato: 
 
Em relação aos Campos: 
 EpcHexa: 
o Tipo: “String”; 
o Detalhe: 
EPC serializado do produto em base Hexadecimal; 
Pode vir nulo se ocorrer algum erro na geração (Sucesso = false , Mensagem = 
Descrição do Erro) 
 Sucesso: 
o Tipo: “Boolean”; 
o Detalhe: 
Flag de Sucesso ou não da operação. Verificar antes de manipular o valor 
“EpcHexa”; 
 Mensagem: 
o Tipo: “String”; 
o Detalhe: 
Mensagem de Retorno do servidor (sucesso ou descrição do erro) 
 
Consultar Epc 
Consulta os EPC’s com base no código de barras e IMEI ou Epc Hexadecimal. 
 
Url da EndPoint de acesso: 
https://cliente.havan.com.br/PortalRfid/Api/BuscarEpc/ 
 
Envio para API: 
Para o Envio será necessário um JSON no seguinte Formato: 
Ou 
 
Em relação aos Campos: 
 Chave de Acesso: 
o Tipo: “String”; 
o Detalhe: 
Chave de Acesso única do Fornecedor. Pode ser consultada no Portal RFID na 
opção “Configurações Rfid” do Menu; 
 BarCode: 
o Tipo: “String”; 
o Detalhe: 
Código de barras do Produto; 
 Imei: 
o Tipo: “String”; 
o Detalhe: 
Número do Imei do produto; 
 EpcHexa: 
o Tipo: “String”; 
o Detalhe: 
Código EPC Hexadecimal gravado na Tag; 
 
https://cliente.havan.com.br/PortalRfid/Api/BuscarEpc/
Retorno da API: 
O retorno da API será um JSON no seguinte formato: 
Em relação aos Campos: 
 Retorno: 
o Tipo: “Objeto” 
o Detalhe: 
Campo de retorno com as informações da Tag. Pode vir nulo. 
o Campos: 
 BarCode: 
 Tipo: “String”; 
 Detalhe: Código de barras do Produto; 
 EpcHexa: 
 Tipo: “String”; 
 Detalhe: EPC serializado do produto em base Hexadecimal; 
 Imei: 
 Tipo: “String”; 
 Detalhe: Número do Imei do produto; 
 Sucesso: 
o Tipo: “Boolean”; 
o Detalhe: 
Flag de Sucesso ou não da operação. Verificar antes de manipular o valor 
“Retorno”; 
 Mensagem: 
o Tipo: “String”; 
o Detalhe: 
Mensagem de Retorno do servidor (sucesso ou descrição do erro) 
 
 
 
 
Deletar associação do EPC 
Deletar associação do número de sério com um produto. 
 
Url da EndPoint de acesso: 
https://cliente.havan.com.br/PortalRfid/Api/DeletarAssociacaoEpc/ 
 
Envio para API: 
Para o Envio será necessário um JSON no seguinte Formato: 
Em relação aos Campos: 
 Chave de Acesso: 
o Tipo: “String”; 
o Detalhe: 
Chave de Acesso única do Fornecedor. Pode ser consultada no Portal RFID na 
opção “Configurações Rfid” do Menu; 
 BarCode: 
o Tipo: “String”; 
o Detalhe: 
Código de barras do Produto a ser gerado o EPC; 
 Imei: 
o Tipo: “String”; 
o Detalhe: 
Número do Imei do produto; 
 
 
https://cliente.havan.com.br/PortalRfid/Api/DeletarAssociacaoEpc/
Retorno da API: 
O retorno da API será um JSON no seguinte formato: 
 
Em relação aos Campos: 
 Retorno: 
o Tipo: “Boolean” 
o Detalhe: 
Retorno da Operação. Pode vir nulo. 
 Sucesso: 
o Tipo: “Boolean”; 
o Detalhe: 
Flag de Sucesso ou não da operação. Verificar antes de manipular o valor 
“Retorno”; 
 Mensagem: 
o Tipo: “String”; 
o Detalhe: 
Mensagem de Retorno do servidor (sucesso ou descrição do erro)