Páginas filhas
  • DI Protheus X DIVICOM Funcionários

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

INTEGRAÇÃO

GPEA010API

GPEA010API - Consulta de Cadastro de Funcionários

Contexto de negócio (Introdução)

Documentação técnica para auxiliar a utilização da API de Integração de Consulta de Funcionários com parceiros TOTVS.

Interessante citar as tendências e necessidades de mercado, o quê, em geral, os software proporcionam (destinam/propósito), principais recursos, etc, e motivos que levaram a criar a integração (em outros termos, o porquê de integrar).

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

  • Sistema/Módulo vertical - Qual o módulo, qual marca, suas principais características, funcionalidades, escopo do módulo, etc
  • BackOffice(s) - Qual(ais) marca(s), o que o ERP engloba, quais são seus pontos fortes, funcionalidades, etc, explanações principalmente no que diz respeito às funcionalidades do ERP que serão utilizadas pela integração (mas sem citar a integração)

Integração

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.

  • Premissas
    Gerais, do Vertical, do BackOffice e dos demais artefatos/sistemas envolvidos
    Premissas Gerais
    Premissas A
    Premissas B
  • Arquitetura (Tecnologia)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas inovações e prestadores de serviços no ramo de benefícios para administrar dentro do RH, empresas e  softwares especialistas na administração de benefícios estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface para que possibilite automatizar o envio dos dados que hoje são realizados manualmente do ERP para o softwares especialista, seja feito através de uma interface de integração.


Sistemas Envolvidos

  • Protheus (módulo  Gestão de Pessoal): Módulo responsável pela gestão dos dados dos funcionários, folha de pagamento e dentre outros cadastros pertinentes aos colaboradores.
  • DIVICOM (Sistema Especialista): Empresa com ampla experiência em gestão de benefícios, sendo pioneira na Administração de benefícios e com atuação no mercado desde 1996 tendo atendido mais de 1.000.000 de clientes.(Dados extraídos do site do próprio parceiro,mais informações).


Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios, envie os dados de funcionários para o sistema da DIVICOM e assim redução no trabalho de inclusão manual de todas as informações dentro do sistema.

  • Benefícios 
    • Normalmente o colaborador responsável ou empresa de benefícios, incluir as informações dos funcionários através de um arquivo (csv, txt) ou até mesmo manualmente, com a interface de integração isso será feito de forma  automática.
    • Não terá um investimento alto de tempo para o cadastramento, pois os dados já serão enviados através da integração a cada requisição do sistema especialista.
  • Arquitetura (Tecnologia)
    • Toda integração entre o Protheus e o Sistema é feita por intermédio de comunicação direta com os Web Services(que são fixos)  REST(Representation State Transfer) utilizando o formato JSON(JavaScript  Object Notation) de serialização de dados, onde através da ativação do serviço do REST do Protheus esteja disponível para utilizar o serviço.
  • Premissas e Propriedades
    • 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 datemodified se desejar uma carga completa(deixar 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;


Escopo

Por intermédio desta integração será disponibilizada a seguinte funcionalidade:

  • Consulta de funcionários;

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameDivicom X Protheus - Funcionários
simpleViewerfalse
diagramWidth673
revision1


Fora do escopo

  • Automatização de Cadastramento de funcionários.
  • 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;

Pré-requisitos instalação/implantação/utilização

  • Versões mínima do Protheus: 12.1.25
  • Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação Protheus que faça uso da mesma.
  • Estrutura de rede estável, para que haja trafego de dados sem interrupção
  • Protheus devidamente configurado e serviço Rest habilitado em seu server.

Ativação/Desativação da integração

Por padrão esta integração estará em repositório, porém demanda realizar a devida configuração conforme abaixo:

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

  • Protheus com sua arquitetura devidamente estruturada.
  • Módulo Gestão de Pessoal com seu cadastro de funcionário devidamente cadastrado

Escopo

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.

Pré-requisitos instalação/implantação/utilização

Relacione quais são os pré-requisitos (técnicos ou de negócio) para a integração. Este tópico não deve incluir informações da implantação normal do módulo, mas apenas informações específicas da integração. É como se este tópico já partisse do princípio que o módulo que será integrado já está normalmente instalado.

Entre os tópicos deste tópico podemos citar:

  • Versões mínima 12.1.25
  • Módulos ou programas que geram informações necessárias a integração. Muitas vezes a integração partirá de informações que somente são trabalhadas em um determinado programa ou processo, que deverá estar em uso no cliente.
  • Ferramentas que são necessárias a integração, como: EAI, ESB, servidor de WebService etc.
  • Aspectos legais nos quais as partes envolvidas na integração devem estar inseridas, caso as informações envolvidas sejam utilizadas para o cumprimento de alguma lei específica.
  • Requisitos de hardware ou Software, como servidores, link de internet, capacidade de armazenamento e memória, sistema operacional.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

Instalação/Atualização

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:

  • Procedimentos que devem ser observados quando um dos produtos for atualizado.
  • Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
  • Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
  • Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
  • Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
  • Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
  • Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.

 

Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM
  • .

Controle de Versã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.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.Observação: Este modelo de suporte está sendo revisado pela TOTVSda linha MicroSiga Protheus, onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

 

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.

Cadastros

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

 

<Transação/Entidade>

Identificador da Mensagem: <mensagem>

Versão: <versão>

Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>

Módulo <marca 2>: <SIGAXXX>

Tipo de Envio: <Assíncrona/Síncrona>

Mensagem Padrão

PROTHEUS

Tabela

Campo

Code

CTO990

CTO_SIMB

Description

CTO990

CTO_DESC

Symbol

CTO990

CTO_SIMB

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita.

Processos

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

 

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita. 

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior.

Esta integração traz a funcionalidade exclusivamente de cadastro de funcionários

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de cadastro de funcionários.

Processos

A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de funcionários e retornar um conjunto de informações pertinentes ao Cadastro de Funcionário(GPEA010) e retornar os dados para o requisitante.

Limitações / Restrições Gerais

  • A integração não contemplará inclusão,alteração e exclusão de registros no Protheus, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.
  • Cada produto deverá gerar um LOG de inclusão e alteração de registros a fim de controlar os dados a serem integrados;
  • A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;


Como realizar a chamada da API REST

Como fazer (opcional)

Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos funcionários desejados.

  • Preenchimento do EndPoint da API GPEA010API;
  • Utilizar a chamada do método Get/ e do Serviço employeedatacontent;
  • Preenchimento dos parâmetros obrigatórios da API;

Formatos de Data

As Entradas e Saídas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DDThh:mm


Parâmetros de Entrada:

Parâmetro

Valor de Exemplo

Obrigatório

TipoParâmetro

Valor Default

Descrição
page1Sim

Integer

query
Página que está
sendo 
sendo requisitada.
pageSize1Não

Integer

query

100

Quantidade de funcionários por página.
productPROTHEUSSim
updateDate

String

query

datemodified2001-01-01T18:25:43
.511Z
NãoStringquery
Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA)
branchIdD MG 01SimStringquery

companyIdT1SimStringquery

authorization

não será informado pelos parâmetros RESTSimStringheader
Configuração do parâmetro 

Security = 1 no arquivo appserver.ini


Parâmetros e Chamada do Método:

Image Added


Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server protheus a API Rest, a  requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}/{api}//rh/v1/employeedatacontent/


Response da API:


Bloco de código
languagecpp
themeConfluence
titleResponse Json
{
   "items": [   {
      "telephone": "                    ",
      "areaCodeMobile": "  ",
      "workCardSerie": "99999",
      "companyKey": "T1|D MG 01 ",
      "workShiftSequence": "  ",
      "badgeNumber": "          ",
      "streetNumber": "      ",
      "complement": "                              ",
      "branch": "D MG 01 ",
      "salaryCategory": "M",
      "roleDescription": "FUNCAO PADRAO       ",
      "workCardNumber": "999999 ",
      "departamentInternalId": "        |         ",
      "socialIntegProgCode": "            ",
      "code": "000001",
      "neighborhood": "               ",
      "birthDate": "1963-06-10T00:00:00",
      "costCenterInternalId": "000000001",
      "zipCode": "        ",
      "areaCode": "  ",
      "name": "JOAO DA SILVA                 ",
      "hiringDate": "1999-03-10T00:00:00",
      "workShiftCode": "001",
      "city": "                    ",
      "roleCode": "00001",
      "costCenterDescription": "TEC PADRAO                              ",
      "gender": "M",
      "street": "TESTE                         ",
      "homeState": "SP",
      "workCardStateIssuing": "SP",
      "workShiftInternalId": "D MG    |001",
      "roleInternalId": "D MG    |00001",
      "departamentCode": "         ",
      "demissionDate": "",
      "costCenterCode": "000000001",
      "employeePositionDescription": "                              ",
      "mobileNumber": "          ",
      "fullName": "                                                                      ",
      "employeeSituation": " ",
      "workshiftDescription": "TURNO UNICO                                       ",
      "id": "T1|D MG 01 |000001",
      "employeePositionCode": "     ",
      "employeePositionCodeInternalId": "        |     ",
      "naturalCity": "SP",
      "contractEnd": "",
      "email": "                                                  ",
      "departmentDescription": "                              "
   }],
   "hasNext": true,
   "total": 3307
}


Dados utilizados da API

Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.


CAMPOS PROTHEUSPROPRIEDADES API RESTDESCRIÇÃO
SM0->M0_CODIGO + "|" + SRA->RA_FILIALcompanyKeyAgrupamento de Empresa, Unidade de negócio e Filial" - SM0->M0_CODIGO
SRA->RA_FILIALbranchFilial do Funcionario
SRA->RA_MATcodeMatricula do Funcionario
SM0->M0_CODIGO + "|" + SRA->RA_FILIAL + "|" + SRA->RA_MATidChave única do funcionário
SRA->RA_NOMEnameNome do Funcionário
SRA->RA_NOMECMPfullNameNome Completo do Funcionário
SRA->RA_CRACHAbadgeNumberNúmero do Crachá
SRA->RA_DEPTOdepartamentCodeCodigo do departamento
QB_FILIAL + "|" + QB_DEPTO + departamentInternalIdInternalId do Departamento
QB_DESCRICdepartmentDescriptionDescrição do Departamento
RA_ADMISSAhiringDateData de Admissão
RA_DEMISSAdemissionDateData de Demissão
RA_NASCbirthDateData de aniversário
RA_SEXOgenderSexo
RA_ENDERECstreetRua do funcionário
RA_NUMENDEstreetNumberNúmero do endereço
RA_COMPLEMcomplementComplemento do endereço
RA_BAIRROneighborhoodBairro do Funcionário
RA_ESTADOhomeStateEstado do Funcinário
RA_NATURALnaturalCityNaturalidade
RA_SITFOLHemployeeSituationSituação do Funcionário na Folha
RA_MUNICIPcityCidade do Funcionário
RA_CEPzipCodeNúmero do Cep
RA_DDDFONEareaCodeCódigo de Área(DDD)
RA_TELEFONtelephoneTelefone
RA_DDDCELUareaCodeMobileCódigo de Área(DDD)
RA_NUMCELUmobileNumberNúmero do Telefone Celular
RA_PISsocialIntegProgCodeNumero do PIS do Funcionário
RA_NUMCPworkCardNumberCarteira de Trabalho do Funcionário
RA_SERCPworkCardSerieSerie da Carteira de Trabalho Profissional
RA_UFCPworkCardStateIssuingUnidade da federação emitente da carteira de trabalho
RA_CCcostCenterCodeCódigo do Centro de Custo
RA_CCcostCenterInternalIdcostCenterInternalId
CTT_DESC01costCenterDescriptionDescrição do Centro de Custo
RA_CARGOemployeePositionCodeCódigo do Cargo do Funcionário
SQ3->Q3_FILIAL + "|" + RA_CARGOemployeePositionCodeInternalIdInternalId do Cargo do Funcionário
Q3_DESCSUMemployeePositionDescriptionDescrição do Cargo do Funcionário
RA_CATFUNCsalaryCategoryCategoria Salarial. Rever estas categorias quando for utilizar com o RM. Produto Datasul também possui outras categorias (Semana, Quinzenal e Diarista)
RA_TNOTRABworkShiftCodeTurno de Trabalho
R6_FILIAL+ "|" + RA_TNOTRABworkShiftInternalIdO InternalID do Turno de Trabalho
R6_DESCworkshiftDescriptionDescrição do Turno de Trabalho
RA_SEQTURNworkShiftSequenceSequência de Turno do funcionário
RA_CODFUNCroleCodeCódigo da Função do Funcionário
RJ_FILIAL + "|" + RA_CODFUNCroleInternalIdInternalID do Código da Função do Funcionário
RJ_DESCroleDescriptionDescrição da Função do Funcionário
RA_DTFIMCTcontractEndData de término do contrato trabalho/experiência
RA_EMAILemailEmail do funcionário

Situações de Erros Tratados

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

404
API RESPONSE

400

Campo RA_USERLGA não foi encontrado.

Habilitar o campo RA_USERLGA pelo configurador.

404
Bloco de código
languagecpp
themeConfluence
titleCampos não estiverem devidamente habilitado
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Campo RA_USERLGA não foi encontrado."
}
400

O Produto é um parâmetro obrigatório.

Preencher o parâmetro Produto.
404
Bloco de código
languagecpp
themeConfluence
titlePropriedade Product vazia
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "O parâmetro product é obrigatório."
}
400

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.
Bloco de código
languagecpp
themeConfluence
titlePropriedade Filial vazia
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "O parâmetro branchId é obrigatório."
}


Mensagens de Pós-Validação

404

Erro

Mensagem

Solução

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.

API RESPONSE
400

Nenhum registro localizado.

Informar outra data de alteração para ser utilizada na consulta.

Exemplo 1:

Exemplo 2:

Exemplo 3:

Bloco de código
languagecpp
themeConfluence
titlePropriedade Filial vazia
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Nenhum registro localizado."
}


Tratamento de Erros Inesperados(TRY/CATCH):

Bloco de código
languagecpp
themeConfluence
titleErro Inesperado
{
   "code": 500,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Ocorreu uma falha no retorno da informação.\r\nErro ao preparar o ambiente com a Empresa e Filial informados!\r\nSaída no final: Falha de conexão com o banco de dados\r\nContacte o administrador do sistema"
}



Checklist de suporte da aplicação

Itens a serem verificados durante o atendimento:

  • Verificar se os pré-requisitos foram atendidos para a chamada da API;
  • Verificar se na chamada da API o EndPoint, o nome do serviço e todos os campos obrigatórios foram informados;
  • Verificar se o retorno da API apresenta algum erro tratado (códigos e mensagens de erro citados neste documento) e consultar a solução na mesma tabela que descreve o erro;
  • Em caso de Erro não tratado, verificar se possui alguma informação de banco de dados, conexão com o servidor ou algo que possa identificar a origem do problema

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

  • Identificar o funcionamento da integração;
  • Identificar a ocorrências de problemas;
  • Coletar evidências do mau funcionamento relatado pelo cliente;
  • Realizar possíveis ajustes na integração quanto à configuração ou negócio.


Anexos