Integração via REST API - RFID ID-COTTON

01. Visão Geral

A integração via REST API tem como objetivo sincronizar dados do TOTVS AGRO Beneficiamento com o ID_COTTON. A sincronização de dados ocorre do TOTVS Agro Beneficiamento para o ID_COTTON e vice-versa.  ID-COTTON é um empresa que tem por finalidade realizar a rastreabilidade do algodão desde o campo (colheita) até a expedição (venda) interna ou externa.

02. Integrações com TOTVS Agro Beneficiamento

• Visão geral

O TOTVS Agro Beneficiamento possui integração direta com o ID-COTTON, utilizando uma API REST.

• Estrutura da integração para consumo de API TOTVS Beneficiamento
  

  O Administrador do TOTVS  RAC deverá criar um perfil “Integracao-Externa” e criar um usuário para acesso as API do TOTVS Beneficiamento e vincular ao perfil configurado para as integrações e associar empresas(organizações). Será informado um e-mail para recebimento de um link para definição da senha que será utilizada para obtenção do token de acesso as API(s).
  
  
  
  
  
  

  Url para obtenção do token: http://ip:porta/api/v1/login/rac/token  (ip e porta do TOTVS Beneficiamento API).
  As estruturas de Json das integrações podem ser obtidas através do SWAGGER das api(s).
  http://ip:porta/api/swagger-ui.html
  Para consumir as APIS do Beneficiamento deve-se obtero token e depois acessar a API correspondente passando o TOKEN obtido.
  
  

• Integração de Lote de Matéria-Prima (Fardão)

  POST: http://ip:porta/api/v1/lotesMateriaPrima/externa
  PUT: http://ip:porta/api/v1/lotesMateriaPrima/externa/{id}
  DELETE: http://ip:porta/api/v1/lotesMateriaPrima/externa/{id}
  
  

• Integração de Contaminantes do Lote de Matéria-Prima (Fardão)

  POST: http://ip:porta/api/v1/lotemateriaprimacontaminantes
  PUT: http://ip:porta/api/v1/lotemateriaprimacontaminantes/{id}
  DELETE: http://ip:porta/api/v1/lotemateriaprimacontaminantes/{id}
  
  

• Integração de Fila de Produção do Lote de Matéria-Prima (Fardão)
  

  POST: http://ip:porta/api/v1/ordensServico/gerarOS/idEmpresa/{idEmpresa}
  
  

• Integração de Fardinhos Produzidos - Recebimento da Etiqueta
  

  POST: http://ip:porta/api/v1/beneficiamentos/etiqueta/{etiqueta}/filaProducao/{filaProducao}
  (Esta API não requer autenticação)
  
  

• Integração de Blocagem Física dos Fardinhos Produzidos
  

  PUT: http://ip:porta/api/v1/blocagens/externa/itemfisico
  
  

03. Integrações com RFID ID-COTTON

• Visão geral

O ID-COTTON possui integração direta com o TOTVS Agro Beneficiamento, utilizando uma API REST.

• Estrutura da integração para consumo de API ID_COTTON
  

  Para consumir as api(s) do ID_COTTON deve-se obter o token de usuário/senha previamente cadastrados no ID-COTTON.
  POST: http://ip:porta/auth 
  Estrutura da mensagem json de envio:
  {
  "password": "senha",
  "username": "usuario"
  }
  
  Estrutura da mensagem json recebida do ID-COTTON

  {

      "data": {

      "token": "string"

     },

       "errors": [

      "string"

    ],

    "userDetails": {

      "authorities": [

        {

          "authority": "string"

        }

      ],

      "id": 0,

      "name": "string",

      "status": "ACTIVE",

      "userName": "string"

    }

  }

  Para consumir as api(s) do ID-COTTON deve ser enviado o token recuperado do usuário/senha enviado para o ID-COTTON e no HEADER da mensagem
  deve ser enviado também as seguintes informações:
  Key = License-Type
  Value = APP_INTEGRATION
  

  
  

• Configuração da integração com o ID-COTTON
  
  

  Configurando e habilitando integração

  
  

• Integração de fardinhos produzidos

  No encerramento do lote de matéria em beneficiamento, se a integração com ID-COTTON estiver habilitada, será gravado na

  tabela BENEFICIAMENTOS_INTEGRACOES o identificador do beneficiamento. Haverá um processo agendado que irá gerar o json e

  realizará o envio para o ID-COTTON, controlando nesta tabela se houve sucesso na integração ou não. Este envio pode ser

  monitorado pela tela. Não será enviado estorno para ID-COTTON, o mesmo irá considerar sempre o ultimo envio.

  
  
  Estrutura da mensagem de integração

  serial	Código do Lote da Matéria-Prima (Fardão)- Etiqueta/Tag de identificação
  erpCode	id do Totvs Beneficiamento do Lote de Matéria-Prima
  unit	Empresa
  erpCode	Identificador do registro da tabela de Empresas - ID
  cottonBales	Fardinhos Produzidos
  erpCode	Id do identificador da tabela de Itens beneficiados no Totvs Beneficiamento
  cottonBaleCode	Etiqueta/Tag de identificação do Fardinho - SAI ABRAPA
  grossWeight	Peso bruto do fardinho
  netWeight	Peso líquido do fardinho (Descontados peso da embalagem)

  
  
  

• Integração de blocos de fardinhos

  
  Toda atualização ou inserção de blocos, se a integração com o ID-COTTON estiver habilitada, será gravado na tabela BLOCAGENS_INTEGRACOES o identificador 
  do bloco. Haverá um processo agendado que irá gerar o json e realizará o envio par o ID-COTTON, controlando nesta tabela se houve sucesso na integração
  ou não. Este envio poderá ser monitorado pela tela. O ID-COTTON irá considerar sempre o ultimo envio.
  
  Estrutura da mensagem de integração
  
  

  erpCode	Identificador do registro da tabela de Blocos - ID
  colourGrade	Classificação por cor do algodão pluma do lote ( Ex.: 31-3 )
  lotNumber	Número do Lote/Bloco
  lotDate	Data da geração do lote
  unit	Empresa
  erpCode	Identificador do registro da tabela de Empresas - ID
  cropYear	Safra
  erpCode	Identificador da Safra
  lotItens	Lista dos fardinhos produzidos do bloco
  erpCode	Identificador da tabela de Itens do Bloco - ID Totvs Beneficiamento
  cottonBale	Fardinhos produzidos
  erpCode	Identificador da tabela de Beneficiamento Itens - ID Totvs Beneficiamento
  cottonBaleCode	Etiqueta/Tag do fardinho produzido - SAI ABRAPA

04. API(s) disponibilizadas para o ID-COTTON 

API(s) disponibilizadas para consumo do ID-COTTON para gerar cadastros no mesmo. Nestas api(s) não são realizadas nenhuma persistência de dados no
TOTVS Agro Beneficiamento.

05. Observações importantes

• Rotinas agendadas

As rotinas de integração com o ID-COTTON são agendadas e ocorrem em um intervalo de 10 em 10 minutos, ou seja, a cada 10 minutos o TOTVS Agro Beneficiamento irá disparar essas integrações.