Menu Docs

Página inicial do DocsServiços Atlas App

Serviços de terceiros [obsoletos]

Nesta página

  • Introdução
  • Conceitos
  • Clientes de serviço [Preterido]
  • Ações de serviço [obsoleto]
  • Regras de serviço [Obsoleto]
  • Webhooks de entrada [Preterido]
  • Guias
  • Serviços integrados
  • Documentação de referência

Importante

Suspensão de serviços de terceiros e notificações push

Os serviços de terceiros e as notificações por push no App Services foram preteridos em favor da criação de pontos de extremidade HTTP que usam dependências externas em funções.

Webhooks foram renomeados e agora são chamados de pontos de conexão HTTPS sem nenhuma alteração em seu comportamento. Recomendamos migrar webhooks existentes.

Os serviços existentes continuarão a funcionar até 1 de novembro de 2024.

Como os serviços de terceiros e as notificações por push agora estão obsoletos, eles foram removidos por padrão da UI do App Services. Para gerenciar um serviço de terceiros ou uma notificação por push existente, adicione as configurações de volta à UI fazendo o seguinte:

  • Na navegação à esquerda, na seção Manage, clique em App Settings.

  • Ative a chave de alternância ao lado de Temporarily Re-Enable 3rd Party Services e salve as alterações.

Os aplicativos modernos geralmente usam vários serviços externos para lidar com casos de uso complexos, como mensagens, análises e gerenciamento de dados. Você pode se conectar a esses serviços por meio do Atlas App Services criando e configurando interfaces de serviço.

As interfaces de serviço especificam os detalhes da conexão para um serviço externo específico e permitem definir o escopo dos recursos desse serviço com regras de serviço personalizadas. Depois de configurar uma interface para um serviço, você pode instanciar um cliente de serviço que se conecta à interface e expõe as ações do serviço como métodos. Você também pode criar webhooks de entrada que permitem que serviços externos se comuniquem diretamente com seu aplicativo por HTTP.

Observação

Clientes de serviço integrado

O App Services inclui clientes para determinados serviços externos, como Twilio e Amazon Web Services. Você também pode usar o HTTP Service para criar uma interface personalizada para qualquer serviço externo que ofereça uma REST API.

Um cliente de serviço é um objeto que se conecta a uma interface de serviço e permite que você chame ações associadas ao serviço. Você pode instanciar clientes de serviço em funções (usando o contexto da função ) bem como no código do aplicativo cliente.

Para obter detalhes sobre como instanciar e usar clientes de serviço, consulte Chamar uma ação de serviço.

Uma ação de serviço é um método que lida com um caso de uso específico para um serviço específico, como enviar uma mensagem de texto com o Twilio ou colocar um objeto em um bucket do Amazon Web Services S3. A ação encapsula detalhes de implementação, como autenticação de solicitação e métodos HTTP, por trás de métodos semânticas específicas para cada serviço.

Quando você chama uma ação de serviço, o App Services avalia cada regra de serviço que se aplica à ação e impede a execução, a menos que uma das regras avalie para true.

Importante

O App Services bloqueia toda ação de serviço por padrão. Você deve configurar uma regra de serviço que habilite uma ação específica antes de chamá-la.

Uma regra de serviço é uma expressão que o App Services avalia para determinar se um usuário pode ou não executar uma ou mais ações em um serviço.

Por exemplo, você pode criar uma regra do Twilio que permite apenas aos usuários enviar uma mensagem de texto de um número de telefone específico ou uma regra da Amazon Web Services que impede os usuários de colocar objeto em um bucket do S3 que não está incluído em uma lista de buckets aprovados.

Observação

Variáveis de Expressão

Variáveis de expressão são variáveis que você pode incluir nas regras de serviço para representar informações dinâmicas sobre seu aplicativo e a execução de uma ação. Você pode configurar regras de serviço com base no usuário autenticado que chamou uma ação (%%user) e nos argumentos que ele forneceu (%%args). Você também pode criar regras complexas que chamam uma Função (%function) e avaliam com base no valor de retorno da Função.

Um webhook de entrada é um manipulador personalizado para evento originados de um serviço externo, como quando alguém abre uma nova solicitação pull no Github ou envia uma mensagem de texto para um número de telefone do Twilio . Comece a usar webhooks recebidos configurando um webhook de serviço.

Os webhooks recebidos consistem em dois componentes principais: o URL do webhook e a função do webhook.

Componente
Descrição
Webhook URL

Uma URL que identifica exclusivamente o webhook de entrada. Os serviços externos podem interagir com o webhook enviando uma solicitação HTTP que corresponda à configuração do webhook à URL do webhook.

Para usar um webhook, forneça a URL do webhook para um manipulador de solicitações HTTP de um serviço externo, que também pode ser chamado de webhook de saída, URL de chamada de resposta ou similar.

Observação

Se um webhook de entrada exigir um parâmetro de query secreto, certifique-se de anexar o parâmetro de query à URL do webhook antes de fornecê-lo ao serviço externo.

Webhook Function
Uma função de webhook é uma Função de Realm que aceita uma solicitação HTTP de entrada com dados do serviço externo como argumento e, opcionalmente, retorna uma resposta HTTP.
Guia
Descrição
Saiba como criar uma nova interface de serviço externo.
Saiba como configurar e executar um webhook de entrada para lidar com eventos em serviços externos.
Saiba como expor com segurança uma ação de serviço para uso em uma função ou aplicativo cliente.
Saiba como chamar uma ação de serviço a partir de uma função ou aplicativo cliente.
assunto
Descrição
Inclui parâmetros de configuração do serviço, instruções para adicionar um webhook ao Twilio e informações adicionais sobre a ação de serviço do Twilio.
Inclui informações adicionais sobre ação do HTTP Service e webhooks.
Inclui parâmetros de configuração do serviço, informações adicionais sobre ação específicas do serviço da Amazon Web Services e instruções genéricas para se conectar a qualquer serviço da Amazon Web Services.
Inclui parâmetros de configuração de serviço, instruções para adicionar um webhook ao Github e orientação sobre como validar solicitações recebidas do Github.
assunto
Descrição
Descreve como verificar as solicitações recebidas, analisar o payload de uma solicitação e enviar uma resposta nas funções do webhook de serviço.
← Notificações por push [Preterido]