< Home

Informações sobre o uso do API do Visipec

Informações técnicas

O API do Visipec é do tipo REST e as respostas às solicitações são retornadas no formato JSON. Toda a comunicação entre o servidor e o cliente requer um protocolo HTTPS para aumentar a segurança na transmissão das informações.

A documentação técnica específica sobre os pontos de extremidade e os parâmetros do Visipec API está disponível em: https://api.visipec.com/api-documentation.html.

Solicitando Acesso

O Visipec foi desenvolvido especificamente para frigoríficos (e empresas de monitoramento) do Brasil, para fortalecer os sistemas de gerenciamento da cadeia de fornecedores e melhorar o processo da tomada de decisão da compra de gado. O Visipec é gratuito e destina-se a complementar os sistemas existentes de monitoramento e rastreabilidade para os fornecedores diretos, com informações sobre a complexa rede de fornecedores indiretos. O sistema também pode fornecer relatórios agregados para varejistas, supermercados, bancos, investidores e intuições financeiras.

As partes interessadas podem entrar em contato com Simon Hall (halls@nwf.org), Kemel Kalif (kalifk@nwf.org), ou Lisa Rausch (lisa@visipec.com) para discutir os procedimentos de acesso para usar o API do Visipec.

Quando enviar uma solicitação, por favor incluir as seguintes informações:

Usando o Visipec - API Client

Desenvolvemos um API Client para facilitar a comunicação com o API do Visipec. Os usuários precisarão ter credenciais de acesso válidas para que o Cliente possa se comunicar com êxito com o API do Visipec.

O API Client do Visipec está disponível para sistemas operacionais Windows e Mac. A seguir, instruções para baixar e usar o API Client do Visipec.

Visipec - API Client (Versão do Windows)

  1. Solicitar credenciais de acesso (consulte Solicitando Acesso acima).
  2. Baixe e instale o .NET Core em sua máquina Windows usando o instalador neste https://dotnet.microsoft.com/download/thank-you/dotnet-sdk-2.2.100-windows-x64-installer.
  3. Faça o download do Visipec - API Client no seguinte link: https://api.visipec.com/downloads/VisipecApiClient_Win.zip
  4. Depois que o arquivo zip for baixado, extraia os arquivos API Client do arquivo zip para a para uma pasta em seu computador local. Você precisa ter os privilégios para salvar e executar arquivos na pasta que você escolher.

        Por exemplo:  C:\VisipecApiClient
  5. Abra a nova pasta que contém os arquivos extraídos e navegue até a pasta chamada “Propriedades”.
  6. Dentro da pasta Propriedades, abra o arquivo chamado appSettings.json usando um editor de texto (por exemplo, WordPad ou Notepad).
  7. Substitua o valor de “userId” pelas credenciais de acesso que foram fornecidas a você e salve o arquivo.

        Por exemplo:  "userId": "85146a97-dfaf-4165-ab31-39g80c0fdba7e",
  8. Abrir um novo prompt de comando

        Menu Iniciar do Windows> Digite “cmd”
  9. Navegue até o diretório que contém os arquivos de programa Visipec API Client:

        Por exemplo:  cd “c:\VisipecApiClient”
  10. Digite o seguinte comando para executar um teste para garantir que o Cliente esteja funcionando corretamente:

        dotnet VisipecApiClient.dll -information

    Exemplo
    {"Successo":true,"Comunicaçao":null,"Resposta":{"Versao":"1.0","Lançado":"2018-11-08T00:00:00","Atualizado":"2018-11-08T00:00:00","TransaçoesContagem":15448871},"Pedido":null}

Caso ocorra algum problema na instalação do API Cliente do Visipec, por favor envie um email para support@visipec.com.

Veja a seguir a seção Operando o API Client do Visipec (opções de linha de comando) com instruções sobre como utilizar o Client após a instalação.


Visipec - API Client (Versão do Mac OS)

  1. Solicitar credenciais de acesso (consulte Solicitando Acesso acima).
  2. Baixe e instale o .NET Core no seu Mac usando o instalador neste link: https://dotnet.microsoft.com/download/thank-you/dotnet-sdk-2.2.100-macos-x64-installer.
  3. Faça o download do Visipec API Client a partir do seguinte link: https://api.visipec.com/downloads/VisipecApiClient_Mac.zip
  4. Once the zip file is downloaded, extract the Client program files from the zip file to a to a folder on your local computer.

        Por exemplo: /users/username/desktop/VisipecApiClient
  5. Abra a nova pasta que contém os arquivos extraídos e navegue até a pasta chamada “Propriedades”.
  6. Dentro da pasta Propriedades, abra o arquivo chamado appSettings.json usando um editor de texto (por exemplo, WordPad ou Notepad).
  7. Substitua o valor de “userId” pelas credenciais de acesso que foram fornecidas a você e salve o arquivo.

        Por exemplo:  "userId": "85146a97-dfaf-4165-ab31-39g80c0fdba7e",
  8. Abra uma nova janela do Terminal
  9. Navegue até o diretório que contém os arquivos de programa Visipec API Client:

        Por exemplo:  cd /users/username/desktop/VisipecApiClient
  10. Digite o seguinte comando para executar um teste para garantir que o Cliente esteja funcionando corretamente:

        dotnet VisipecApiClient.dll -information

    Exemplo
    {"Successo":true,"Comunicaçao":null,"Resposta":{"Versao":"1.0","Lançado":"2018-11-08T00:00:00","Atualizado":"2018-11-08T00:00:00","TransaçoesContagem":15448871},"Pedido":null}

Caso ocorra algum problema na instalação do API Cliente do Visipec, por favor envie um email para support@visipec.com.

Veja a seguir a seção Operando o API Client do Visipec (opções de linha de comando) com instruções sobre como utilizar o Client após a instalação.


Operando o Visipec API Client (Opções de Linha de Comandos)

Nota: A saída do API do Visipec está no formato JSON estruturado. Para visualizar os dados utilize o JSON viewer disponivíel em: http://jsonviewer.stack.hu or https://jsoneditoronline.org.

API Information Request

Uso:
dotnet VisipecApiClient.dll -information -out outputFilePath

Parâmetros:
Nome Entrada Esperada Requerida Descrição
-out outputFilePath No Local para salvar a resposta do servidor. Se deixado em branco, a resposta será impressa na tela.

Propriedade Pesquisa

Uso:
dotnet VisipecApiClient.dll -propriedade carNumbers -start transactionStartDate -end transactionEndDate -out outputFilePath

Parâmetros:
Nome Entrada Esperada Requerida Descrição
-propriedade carNumbers Sim Lista de números de CAR separada por vírgula para solicitar informações
-out outputFilePath Não Local para salvar a resposta do servidor. Se deixado em branco, a resposta será impressa na tela.
-start transactionStartDate Não Todas as informações de transação retornadas serão posteriores a esta data. Formato: MM/DD/AAAA
-end transactionEndDate Não Todas as informações de transação retornadas serão anteriores a essa data. Formato: MM/DD/AAAA

Pesquisa do matadouro:

Uso:
dotnet VisipecApiClient.dll -frigorifico sifNumber -start transactionStartDate -end transactionEndDate -out outputFilePath

Parâmetros:
Nome Entrada Esperada Requerida Descrição
-frigorifico sifNumber Sim Um único número SIF
-out outputFilePath Não Local para salvar a resposta do servidor. Se deixado em branco, a resposta será impressa na tela.
-start transactionStartDate Não Todas as informações de transação retornadas serão posteriores a esta data. Formato: MM/DD/AAAA
-end transactionEndDate Não Todas as informações de transação retornadas serão anteriores a essa data. Formato: MM/DD/AAAA

Usando um Cliente da API REST Personalizado ou Genérico

Para obter documentação técnica específica sobre parâmetros da API do Visipec, visite https://api.visipec.com/api-documentation.html.

Autenticação

Para iniciar uma sessão de usuário válida com o API do Visipec, os usuários devem primeiro se autenticar no sistema usando uma solicitação POST para o terminal JWT. As solicitações válidas receberão um token de portador JWT em resposta. Esse token do portador JWT pode ser usado para enviar solicitações futuras à API do Visipec até que a sessão expire.

Por exemplo, usando um cliente genérico comum, como curl, um usuário poderia enviar a seguinte solicitação para o API do Visipec:

curl -X POST "https://api.visipec.com/api/Jwt" -H "accept: application/json" -H" Tipo de conteúdo: aplicativo / json "-d" {\ "Token \": \ "SEU-TOKEN-AQUI \"} "

Jwt Bearer Tokens

O POST de autenticação acima retornará um Token JWT (JSON Web Tokens) de portador que será necessário para qualquer solicitação válida para a propriedade do API do Visipec e os pontos de extremidade do matadouro.

Solicitações de Exemplo

Endpoint de Informações de: curl -X GET "https://api.visipec.com/api/information" -H "accept: application/json" -H "Authorization: Bearer SEU-TOKEN-AQUI" Endpoint de Propriedade: curl -X GET "https://api.visipec.com/api/v10/propriedade?carNumbers=MT-5106158-DCA64AE01E2A440C83ACDC860E9A770F&pageNum=1" -H "accept: application/json" -H "Authorization: Bearer SEU-TOKEN-AQUI" Endpoint de Frigorífico: curl -X GET "https://api.visipec.com/api/v10/frigorifico?sifs=4554&pageNum=1" -H "accept: application/json" -H "Authorization: Bearer SEU-TOKEN-AQUI"

Observe que o endpoint do Frigorífico está disponível apenas com permissão dos administradores do Visipec API. Entre em contato com Simon Hall (halls@nwf.org) ou Lisa Rausch (lisa@visipec.com) para discutir o recebimento de acesso a dados de pesquisa relacionados a um número SIF especificado.