Conexões externas

Conecte outro serviço com o contexto de projeto certo

Descreva o serviço externo a conectar, forneça sua documentação e associe-o às áreas de negócio correspondentes.

Reúna a documentação e os dados de acesso

Declare o serviço

Identifique a API externa e forneça um link ou um texto de documentação.

Separe os dados de acesso

Forneça as credenciais de teste e de produção solicitadas para a conexão.

Ligue o contexto de negócio

Associe uma conexão existente às áreas que a utilizam.

Dê a uma integração as informações de que ela precisa

Uma conexão começa pelo nome do serviço e pela documentação. Explique qual ação de negócio a exige e quais informações devem circular entre os sistemas.

A declaração aceita dados de acesso separados para teste e produção. Revise esses dados na página de detalhe da conexão, mantendo claro o contexto do ambiente.

Prepare uma integração em torno da ação de negócio que ela suporta

Explique a troca de que você precisa. Um serviço externo pode fornecer ou receber informações usadas por uma tarefa de negócio. Declare seu nome e sua documentação e depois explique a troca pretendida no contexto do projeto. Isso dá à integração uma finalidade prática além da URL de um serviço.

Diferencie teste de produção. As credenciais de teste e de produção podem pertencer a contas diferentes do fornecedor. Mantenha-as nos campos correspondentes e verifique o uso pretendido. Separar esses contextos ajuda a preparar a integração para as etapas de desenvolvimento e de produção.

Reutilize uma conexão declarada. O mesmo serviço externo pode atender a várias áreas de negócio. Ligue a conexão existente onde ela faz sentido e depois revise suas associações. Desassociá-la de uma área e excluí-la do projeto inteiro são decisões diferentes.

Reutilize a conexão onde ela faz sentido

Uma conexão declarada pode ser ligada a mais de uma área de negócio. Examine as conexões ligadas em uma área e associe ou desassocie o serviço adequado.

Declarar o serviço fornece os requisitos da integração. Revise seu status e teste o fluxo de trabalho de negócio completo antes de confiar nele em produção.

Explique a troca de que seu aplicativo precisa

Especifique o serviço, as informações a enviar ou receber e a área de negócio que o utiliza. Um link para a documentação atual ajuda a descrever o contrato externo real.

Descreva um exemplo útil e a resposta esperada quando o serviço estiver indisponível. A conexão pode então ser discutida em termos do trabalho dos seus usuários, e não apenas do nome de um fornecedor.

Da declaração do serviço a um fluxo de trabalho testado

Forneça as informações do serviço. Forneça um link para a documentação ou seu conteúdo e os dados de acesso solicitados. Identifique a operação de negócio que exige a conexão.

Associe as áreas certas. Ligue a conexão declarada às áreas que a utilizam. Revise as associações existentes antes de adicionar ou remover uma.

Verifique a integração concluída. Acompanhe seu status e teste a troca pretendida no ambiente correspondente. A declaração, sozinha, não prova que o fluxo de trabalho está funcionando.

What your application can connect

Two statuses only. Available: included in every application, nothing to build. On request: built during your project with the provider's own API, from its documentation and your own account with that provider.

Available in every application

  • Email sending

    Available

    Your application sends its emails from an address on your own domain, once that address and the domain are validated in its back office.

  • Text messages

    Available

    Your application sends text messages, such as phone verification codes, under a shared sender name. A sender name of your own needs a registration first.

  • Conexões externas

    Available

    In Connectors, you declare a service with its documentation and its test and production access details, then attach it to the business areas that use it.

Built on request with the provider's API

  • Um serviço com uma API documentada

    On request

    Um serviço que publica sua documentação de API pode ser conectado a partir dessa documentação e ao seu acesso de teste e produção. A viabilidade é confirmada quando o escopo é revisado.

  • Seu software de negócios

    On request

    Um software de ERP, contábil ou CRM que publica uma API: os registros trocados, sua direção e sua periodicidade são especificados pela área de negócio que os utiliza.

  • Listas do Brevo

    On request

    Assinantes que deram seu consentimento, enviados para as listas da sua própria conta Brevo. O Ultineo E-commerce já executa essa sincronização.

  • Google Ads

    On request

    Autorização na própria tela de consentimento da Google com a conta que gerencia seu anúncio, e em seguida, suas campanhas existentes originaram-se do seu aplicativo. A Ultineo E-commerce já se conecta ao Google Ads dessa forma.

  • OVHcloud

    On request

    Domínios, zonas de DNS e outros recursos da sua conta OVHcloud, gerenciados a partir da sua aplicação através da API OVHcloud. Uma aplicação construída no mesmo mecanismo já faz isso.

Leia o guia prático

Prepare a conexão de que seu aplicativo realmente precisa

Comece pela documentação do serviço e pelo resultado de negócio. Mantenha os dados de acesso e as associações claros ao longo de todo o projeto.

Perguntas sobre conexões externas

Informe o nome do serviço externo e um link para a documentação ou o conteúdo colado. Forneça os dados de acesso solicitados para teste e produção. Um nome, sozinho, não define o comportamento da integração.

Uma conexão existente pode ser associada a várias áreas de negócio. Revise as áreas ligadas nos detalhes do conector para que seu escopo continue compreensível.

Uma conexão externa descreve como seu aplicativo usa outro serviço. A API de projeto opcional expõe as operações acordadas do seu aplicativo. Elas atendem a necessidades de integração diferentes.

Desassociar um conector diz respeito à sua ligação com uma área. Remover o conector do projeto é uma ação separada, com outro escopo; revise a confirmação antes de prosseguir.

Acompanhe a implementação e teste a troca de negócio completa. O serviço declarado e seu estado de ativação são um contexto útil, mas não substituem a verificação do resultado.