Pular para o conteúdo principal
As integrações de workspace permitem registrar APIs externas compartilhadas no nível do workspace a partir de uma especificação OpenAPI. Você importa uma spec (URL ou JSON), seleciona até 30 operações e conecta a API uma vez no seu workspace. Qualquer app nesse workspace pode então chamar essas operações aprovadas via base44.integrations.custom.call(), em vez de configurar sua própria conexão. Isso funciona para APIs internas e APIs de parceiros das quais sua equipe depende.
Integrações em um workspace no Base44
Essas integrações são projetadas para serem seguras e confiáveis. Cabeçalhos de autenticação sensíveis são armazenados como segredos criptografados do workspace e nunca são enviados de volta ao navegador. Em tempo de execução, as chamadas são feitas por proxy do lado do servidor com proteções contra falsificação de requisição do lado do servidor (SSRF), e os cabeçalhos do workspace têm precedência para que os apps não possam substituí-los. Editar uma integração usa a especificação armazenada em vez da URL ao vivo, e salvar é bloqueado se os cabeçalhos falharem ao carregar para que você não os perca por engano.
Importante:
  • O acesso a integrações de workspace é restrito a admins e proprietários de workspace em um plano Builder ou superior.
  • Qualquer membro do workspace pode usar uma integração de workspace existente em seus apps, mesmo em um plano gratuito.

Entendendo as integrações de workspace

Uma integração de workspace é uma conexão compartilhada do seu workspace para uma API externa ou interna, como um CRM, sistema de suporte ou backend personalizado. Você a define uma vez no seu workspace a partir de uma especificação OpenAPI ou Swagger, escolhe quais operações são permitidas e qualquer app compatível nesse workspace pode chamar essas operações. Isso mantém a configuração em um único lugar e facilita o gerenciamento dos sistemas externos dos quais sua equipe depende. Integrações de workspace são úteis quando você quer:
  • Usar a mesma API externa ou interna em vários apps no mesmo workspace.
  • Manter detalhes sensíveis, como chaves de API e tokens, em um lugar seguro, gerenciados como segredos do workspace.
  • Limitar quais endpoints estão disponíveis para que os apps chamem apenas operações aprovadas e definidas em spec.
  • Manter uma separação clara dos conectores OAuth de um clique, já que as integrações de workspace são gerenciadas pelo workspace e orientadas por spec.
  • Deixar claro de quais sistemas externos seu workspace depende.

Criando uma integração

Crie uma integração de workspace personalizada quando quiser expor uma nova API externa aos seus apps e essa API tem uma especificação OpenAPI ou Swagger. A Base44 lê a especificação, permite que você escolha os endpoints que quer expor e cria uma integração reutilizável para seu workspace.
Antes de começar: Certifique-se de ter acesso a uma especificação OpenAPI ou Swagger válida para a API que deseja usar. Você pode hospedá-la em uma URL pública ou copiar o JSON.

Passo 1 | Adicione uma nova integração

  1. Clique no nome do seu workspace no canto superior esquerdo da sua conta.
  2. Clique em Settings.
  3. Clique em Integrations.
  4. Clique em New Integration.
  5. Escolha como deseja fornecer sua especificação de API:
    • From URL: Insira a URL pública do seu arquivo OpenAPI ou Swagger no campo OpenAPI Specification URL, por exemplo https://api.example.com/openapi.json.
    • Paste JSON: Cole a definição JSON completa da sua especificação OpenAPI ou Swagger no editor.
  6. Clique em Continue.
Adicionando uma integração personalizada em um workspace

Passo 2 | Selecione endpoints para expor

Selecione até 30 endpoints para sua integração. Para selecionar endpoints:
  1. Revise a lista de endpoints que a Base44 descobre na sua especificação. Você pode usar a caixa de pesquisa para encontrar caminhos ou operações específicas por método ou nome do caminho.
  2. Selecione as caixas para os endpoints que deseja expor ao seu workspace.
  3. Clique em Continue.
Selecionando os endpoints para expor para sua integração de workspace

Passo 3 | Configure sua integração

Configure os detalhes da sua integração, defina a URL base e adicione quaisquer cabeçalhos personalizados que sua API precisa. Valores de cabeçalho sensíveis permanecem protegidos. Cabeçalhos comuns de autenticação como authorization, x-api-key, api-key, x-auth-token, x-access-token, x-secret-key, bearer, secret, password e credential são sempre tratados como segredos. Seus valores são armazenados como segredos criptografados do workspace, nunca enviados de volta ao navegador, e aparecem como “sensitive – delete to change” quando você edita a integração. Para configurar sua integração:
  1. Defina os detalhes da sua integração:
    • Slug: Insira um identificador amigável para URL para a integração, por exemplo my-api.
    • Name: Insira o nome de exibição que aparece na lista de integrações do seu workspace.
    • Description: Descreva o que a integração faz para que os colegas saibam quando usá-la.
    • Base URL: Confirme ou atualize a URL base para sua API.
  2. Se sua API exigir cabeçalhos que devem ser enviados com cada requisição, adicione-os na seção Custom Headers:
    1. Clique em Add Header.
    2. Insira o nome do cabeçalho, como Authorization ou X-API-Key.
    3. Insira o valor do cabeçalho, como sua chave de API ou token.
    4. Use o ícone de visibilidade para ocultar ou revelar o valor do cabeçalho conforme necessário.
  3. Revise a lista de endpoints selecionados na parte inferior da caixa de diálogo.
  4. Clique em Create Integration.
Configurando sua integração de workspace

Gerenciando integrações de workspace

Depois de criar uma integração de workspace, ela aparece na aba Integrations do seu workspace. A partir daí, você pode visualizar seus detalhes, editar configurações ou removê-la se não precisar mais.

Visualizando detalhes da integração

  1. Clique no nome do seu workspace no canto superior esquerdo da sua conta.
  2. Clique em Settings.
  3. Clique em Integrations.
  4. Veja a integração que deseja inspecionar e expanda os endpoints.

Editando uma integração

  1. Clique no nome do seu workspace no canto superior esquerdo da sua conta.
  2. Clique em Settings.
  3. Clique em Integrations.
  4. Clique no ícone More Actions no card da integração.
  5. Clique em Edit.
  6. Atualize os campos necessários e salve suas alterações.
Editando uma integração de workspace
Se precisar expor endpoints adicionais da mesma API, considere criar uma nova integração ou atualizar a existente com base em como deseja que os apps a utilizem.

Excluindo uma integração

  1. Clique no nome do seu workspace no canto superior esquerdo da sua conta.
  2. Clique em Settings.
  3. Clique em Integrations.
  4. Clique no ícone More Actions no card da integração.
  5. Clique em Delete.
  6. Clique em Delete novamente para confirmar que deseja removê-la do workspace.
Excluindo uma integração de workspace
Importante: Excluir uma integração de workspace pode quebrar quaisquer integrações no nível do app que dependem dela. Certifique-se de revisar os apps ativos antes de remover uma integração compartilhada.

Perguntas frequentes

Clique em uma pergunta abaixo para saber mais sobre integrações de workspace.
Depois de criar uma integração de workspace, todos os novos apps que você construir nesse workspace podem usá-la.Quando você cria um novo app, a Base44 verifica suas integrações de workspace. Se você mencionar um desses sistemas no seu primeiro prompt, ela automaticamente usa a integração de workspace correspondente. Por exemplo, se você já adicionou uma integração da API do GitHub e diz “Crie um app baseado nas minhas issues do GitHub”, a Base44 usa a integração do GitHub configurada para o workspace sem que você precise selecioná-la.Você pode então revisar e ajustar como o app usa essa integração nas configurações de integrações do app.
Para criar ou gerenciar integrações de workspace, você precisa ser proprietário ou admin de workspace em um plano Builder ou superior com acesso à aba Integrations nas configurações do seu workspace. Se não vir o botão Add Integration ou as opções de edição, entre em contato com o admin do seu workspace e peça para atualizar sua função ou criar a integração para você.
Se o proprietário da API atualizar a especificação na URL que você usou, os detalhes que a Base44 lê dela podem mudar na próxima vez que você atualizar ou recriar a integração. Quando souber que a spec mudou, revise sua integração de workspace e verifique se os endpoints expostos ainda correspondem ao que seus apps esperam.
Os valores dos cabeçalhos, como chaves de API e tokens, são armazenados como parte da configuração da integração de workspace. Apenas colegas com permissão para gerenciar integrações de workspace podem visualizar ou editar esses valores. Use o ícone de visibilidade no passo Configure para ocultar valores na tela quando trabalhar em espaços compartilhados.
Sim. Você pode criar várias integrações de workspace que apontam para a mesma API externa. Por exemplo, você pode criar integrações separadas para ambientes sandbox e produção, ou para diferentes conjuntos de endpoints que são usados por diferentes apps.
Quando precisar rotacionar uma chave ou token, gere a nova credencial no sistema externo primeiro. Em seguida, edite a integração de workspace, atualize o valor do cabeçalho relevante com a nova chave ou token e salve suas alterações. Depois de atualizar a integração de workspace, os apps que a usam começam a enviar o novo valor automaticamente.
Verifique se a URL aponta diretamente para um arquivo JSON ou YAML OpenAPI ou Swagger válido e se é publicamente acessível pelo seu navegador. Se o arquivo está atrás de autenticação ou servido como HTML, a Base44 não pode analisá-lo.Se você ainda ver erros, mude para a opção Paste JSON, copie o JSON bruto da sua especificação e tente novamente.Para um teste rápido, você também pode tentar uma spec válida conhecida, como uma API de amostra pública, para confirmar que o fluxo funciona.
Esta página foi traduzida usando IA. Para informações mais precisas e atualizadas, consulte a versão em inglês.