Documentação técnica para auxiliar o desenvolvimento de APIs de integração com os produtos TOTVS.
Integração passiva que poderá ser consumida pelas linhas RM, DataSul e Protheus.
O que levou a criação da integração / o porquê da integração (Finalidade/Objetivo), de forma macro, o que será integrado do, por exemplo, Vertical com o ERP (BackOffice)
Explique o contexto de negócio ou do problema na qual esta integração estará inserida. Isto inclui o funcionamento da(s) ponta(s) envolvida(s).
Apresentar a integração como uma melhoria para o cenário ou como uma solução para o problema.
- O parceiro que será responsável pela requisição e transformação da informação recebida;
- Cada produto deverá gerar um LOG de inclusão(RA_USERLGI) e alteração(RA_USERLGA) de registros a fim de controlar os dados a serem integrados;
- Na requisição, o parceiro deverá informar através do preenchimento do parâmetro updateDate se deseja a carga completa(deixando o parâmetro vazio) ou somente os dados que foram atualizados(Informando a data de alteração). Caso seja solicitada a carga, todos os dados deverão ser enviados novamente. Caso seja solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
- A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;
- Será implementado um controle de paginação a fim de facilitar o envio da informação para o solicitante. Neste processo o solicitante deverá informar qual é o tamanho da informação solicitada e qual página ela solicita;
- Cabe a integração informar se existem mais páginas a serem solicitadas;
Comunicação através de API REST (Representation State Transfer) utilizando o formato JSON (JavaScript Object Notation) de serialização de dados.
Descreva, dado o contexto, qual o escopo de atuação da integração. Cite as áreas/perfis de usuários e funções impactadas. Se existe uma parte do contexto de negócio que a integração não tenta resolver, deixe explícito.
Defina exatamente o que a integração FAZ, o que ela NÃO FAZ e a sua finalidade.
[O conteúdo poderá estar disponível na ferramenta PMS – Painel de Gestão de Projetos, opção Plano do Projeto]
Como são os processos os que serão integrados, mas com uma visão geral e não só o ponto de integração caso contrário a homologação [ou outro que pegar o documento] não saberá do que se trata no sistema vertical, de forma sucinta, como funciona e o(s) ponto(s) de integração.
Citar a responsabilidade de cada produto.
Descrever com mais detalhes sobre o que será integrado (mas não ser especialista nas entidades/processos, pois suas particularidades serão descritas posteriormente) incluindo diagramas, prints, imagens, etc o que for interessante para auxiliar o entendimento.
Interessante aqui a inclusão de diagramas, imagens, lógicas, fluxo(s) do(s) processo(s) o que considerar interessante e agregador ao documento e ao escopo.
Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
O suporte aos recursos da Integração será de responsabilidade da linha MicroSiga Protheus.
Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.
Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.
Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
- O serviço de disponibilização de dados de Funcionário apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante;
- Cada produto deverá gerar um LOG de inclusão e alteração de registros a fim de controlar os dados a serem integrados;
- Na requisição, o parceiro deverá informar através do preenchimento do parâmetro updateDate se deseja a carga completa(deixando o parâmetro vazio) ou somente os dados que foram atualizados(Informando a data de alteração). Caso seja solicitada a carga, todos os dados deverão ser enviados novamente. Caso seja solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
- A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;
- Há um controle de paginação a fim de facilitar o envio da informação para o solicitante. Neste processo o solicitante deverá informar qual é o tamanho da informação solicitada(quantos funcionários serão retornados por página) e qual página ela solicita;
- Cabe a integração informar se existem mais páginas a serem solicitadas, de acordo com a quantidade de funcionários e os dados informados na requisição.
Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos funcionários desejados.
As Entradas e Saídas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DDThh:mm:ssZ
Parâmetros de Entrada:
Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição |
page | 1 | Sim | Integer | Página que está sendo requisitada. | |
pageSize | 1 | Não | Integer | 100 | Quantidade de funcionários por página. |
product | PROTHEUS | Sim | String | ||
updateDate | 2001-01-01T18:25:43.511Z | Não | String | Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA) | |
branchId | D MG 01 | Sim | String | ||
companyId | T1 | Sim | String | ||
authorization | não será informado pelos parâmetros REST | Sim | String | Configuração do parâmetro Security = 1 no arquivo appserver.ini |
Parâmetros e Chamada do Método:
Response da API:
O envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução.
Tratamento de erros de integração Protheus:
Mensagens de Pré-Validação
Erro | Mensagem | Solução | API RESPONSE |
404 | Campo RA_USERLGA não foi encontrado. | Habilitar o campo RA_USERLGA pelo configurador. | |
404 | O Produto é um parâmetro obrigatório. | Preencher o parâmetro Produto. | |
404 | A Filial é um parâmetro obrigatório. | Preencher o parâmetro Filial. | |
404 | A página é um parâmetro obrigatório e deve ser maior que 1. | Preencher o parâmetro Page com um valor maior que 1. |
Mensagens de Pós-Validação
Erro | Mensagem | Solução | API RESPONSE |
404 | A página solicitada é maior do que a quantidade disponível na consulta. | Preencher o parâmetro Page com um valor menor que o solicitado. | |
404 | Nenhum registro localizado. | Informar outra data de alteração para ser utilizada na consulta. |
Tratamento de Erros Inesperados(TRY/CATCH):
Itens a serem verificados durante o atendimento: