Passar para o conteúdo principal

Pré-requisitos para a integração com a Linkana

Escrito por Débora Sampaio
Atualizado essa semana

Antes de iniciar um projeto de integração, é necessário que algumas condições estejam atendidas. Este artigo descreve o que precisa estar resolvido do lado do cliente para que o projeto avance sem bloqueios.

Pré-requisitos de negócio

Essas são as decisões e definições que precisam estar tomadas antes da fase de validação de escopo.

1. Designar um responsável técnico

O cliente deve indicar uma pessoa com conhecimento dos sistemas a serem integrados e autonomia para tomar decisões técnicas durante o projeto. Essa pessoa será o ponto de contato principal com a equipe da Linkana ao longo de todas as fases.

2. Definir quais sistemas serão integrados

É necessário ter clareza sobre qual sistema será a origem do fornecedor (ERP, sistema de requisição, etc.) e qual será o destino das informações de homologação. Projetos com múltiplos sistemas envolvidos requerem escopo separado por sistema.

3. Definir regras de deduplicação

Se o sistema de origem puder conter múltiplos registros para o mesmo fornecedor (por exemplo, múltiplos IDs para o mesmo CNPJ), o cliente precisa definir as regras para identificar e tratar esses duplicados. A Linkana trabalha com o modelo de um fornecedor por CNPJ.

4. Definir o fluxo operacional pós-integração

Como os usuários internos criarão novos fornecedores? Qual sistema é o ponto de entrada? O fornecedor deve receber comunicações apenas da Linkana ou também do sistema de origem? Essas definições precisam estar claras antes do desenvolvimento.


Pré-requisitos técnicos

Esses são os recursos que o cliente precisa disponibilizar para que a Linkana consiga desenvolver e testar a integração.

1. Conectividade aos ambientes

A Linkana é um serviço na nuvem e precisa conseguir se comunicar com os sistemas do cliente pela internet. Se a sua empresa possui restrições de firewall ou políticas de acesso por IP, será necessário liberar as conexões de entrada vindas da Linkana — tanto no ambiente de testes quanto no de produção.

Caso o sistema a ser integrado esteja hospedado em servidor local (on-premise), ele precisará ser exposto à internet (por meio de um hostname público, por exemplo). Sistemas acessíveis apenas dentro da rede interna da empresa não conseguem receber requisições da Linkana. Se você não souber se esse é o seu caso, consulte o time de infraestrutura da sua empresa antes de iniciar o projeto.

2. Perfis de acesso e credenciais

É necessário disponibilizar as credenciais de acesso às APIs ou serviços que serão consumidos — tanto para o ambiente de testes quanto para o de produção. Credenciais devem ter as permissões necessárias para leitura e escrita nos recursos envolvidos na integração.

3. Documentação dos endpoints

O cliente (ou o fornecedor do sistema) deve disponibilizar a documentação técnica dos endpoints que serão utilizados, incluindo formatos de autenticação, estrutura de requisição e resposta, e eventuais limites de uso (rate limits, paginação, etc.).

4. Ambiente de testes disponível

Antes do go-live, todos os fluxos são validados em um ambiente de homologação. O cliente deve garantir que existe um ambiente de testes funcional e representativo do ambiente de produção, com o mínimo necessário para executar os testes integrados.

5. Disponibilidade durante os testes

Os testes são conduzidos pelo time de negócio do cliente — são eles que têm a visão do processo e conseguem validar o fluxo completo, incluindo etapas que acontecem dentro do sistema do cliente e às quais a Linkana não tem acesso, como a utilização do fornecedor após a conclusão da homologação.

Durante toda a fase de testes, a Linkana permanece disponível para acompanhamento, esclarecimento de dúvidas e correção de eventuais inconsistências identificadas. O objetivo é que o cliente chegue ao go-live com total confiança no fluxo validado. Da mesma forma, é necessária a disponibilidade do responsável técnico do cliente para apoio nessa etapa, quando for preciso.

Respondeu à sua pergunta?