Início / PTRP / Integração

Requisição CURL para o Gateway SREP

O que é o Comando CURL? 

É um comando disponível na maioria dos sistemas baseado em Unix. Ele é usado como abreviação para “Client URL”. Comandos CURL são destinados para funcionar como uma forma de verificar a conectividade da URL, além de ser uma ótima ferramenta de transferência de dados.

Para utilizar, basta fazer uma requisição CURL para o Gateway da Prime no terminal de comando do sistema operacional, com o seu e-mail do contexto e sua senha, especificando o REP que contém os dados, através de seu NFR, e o intervalo de datas que deseja visualizar as marcações, resultando em um JSON com os dados gravados.


Requisição utilizando o CURL no Gateway da Prime:


Ambiente Unix 


  • *Valores em vermelho serão substituídos pelas suas informações.
curl -i --user email@seuContexto:suaSenha -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"nfr":"00010000270000663", "dataHoraInicio":"20191001", "dataHoraTermino":"20191030"}' https://portal.primesw.com.br/gateway/rest/afd
  • Parâmetros:
    • -i : inclui o header de protocolo de response no output.
    • --user: usuário e senha de autenticação, no caso e-mail com o contexto e senha.
    • -H: Passando um header customizado.
    • -X: Especifica qual comando da requisição utilizar, no caso POST.
    • -d: HTTP POST data (dados).
    • Corpo Json: "nfr": Número do REP a ser requisitado, "dataHoraInicio": limite inicial do período a ser requisitado (AAAAMMDD), "dataHoraTermino": limite final do período a ser requisitado(AAAAMMDD).
    • URL:  URL a ser requisitada https://portal.primesw.com.br/gateway/rest/afd


Exemplo:

  • *Lembrando que o e-mail, seuContexto, suaSenha, nfr e intervalo de datas devem ser substituídos pelas suas informações
  • Saída usando o usuário(email) main e contexto primesw.

JSON:
  • "success":  indica o sucesso da requisição.
  • "message": mensagem do retorno da requisição.
  • "rows": vetor que contém os dados do retorno da requisição. Caso não haja valores no período especificado, ele vem como vazio.
  • "nsr":  número sequencial de registro.
  • "pis": número do PIS ou PID(Prime ID) referente a pessoa do registro.
  • "dataHora": horário no qual o registro foi realizado.
  • "cpf":caso o exista, documento referente a pessoa do registro.


Ambiente Windows



A partir da build 1803 do Windows 10, não há a necessidade de instalar o CURL, pois ele já vem por padrão no sistema, presente na pasta do System32. Para executá-lo é necessário executar o cmd com privilégio de administrador.    

Lembrando também que o cmd do Windows tem uma interpretação diferente do shell linux em relação as aspas duplas e simples, por este motivo, o comando ficará diferente entre as plataformas.

Nesse caso, no Windows será usado somente aspas duplas e usando o caracter "\" entre os textos internos do JSON no parâmetro data do POST:

ex: -d "{\"param\":\"value\"}"

comando: 

curl -i --user email@seuContexto:suaSenha -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d "{\"nfr\":\"00010000270000663\", \"dataHoraInicio\":\"20191001\", \"dataHoraTermino\":\"20191030"\}" https://portal.primesw.com.br/gateway/rest/afd


Entretanto, para facilitar o procedimento nesta plataforma, sugerimos uma abordagem mais simples, na qual utilizará um software de teste de API, conforme procedimento abaixo:


  • Realize o download do software Insomnia no link: https://insomnia.rest/
  • Após realizar a instalação, clique  no símbolo de adição e selecione a opção New Request:


  • Nesta opção, dê um nome para a requisição, e selecione no primeiro combo ao lado o método POST e no segundo o tipo JSON


  • Na nova tela, com a primeira aba denominada JSON selecionada, digitar em seu corpo o JSON referente ao número de série do REP e o período, no padrão ano mês dia, desejado para visualizar os dados. O JSON segue uma estrutura de chave e valor, entre chaves e aspas, ex:{"nfr":"00010000270000663", "dataHoraInicio":"20191001", "dataHoraTermino":"20191030" }, conforme a imagem:


  • Na segunda aba com o nome Auth, selecionar o primeiro campo Basic Auth:


  • Nesta tela colocar os seus dados referente a sua identificação, e-mail do contexto na prime e sua senha:



  • O sistema irá carregar, e caso todas as informações estejam corretas, o retorno dos dados solicitados será mostrado em uma tela à direita:


(resultado na aba "Preview", no lado direito da tela)