Autenticação da API REST

Visão geral

Toda requisição à API REST de integrações em https://api-connect-us.bridge.new usa uma chave de API no cabeçalho x-api-key. Essa chave identifica seu aplicativo e autoriza o acesso aos recursos do Bridge em nome da sua organização.

Tipo de integração	Uso das credenciais
API REST de integrações	`x-api-key` no servidor, enviada para `https://api-connect-us.bridge.new`.
Webhooks	Seu receptor verifica a chave de API configurada para o webhook, a assinatura HMAC e a política de validade do timestamp. Siga o guia de verificação de assinaturas.
Custom Connections	`captureKey` pública e reCAPTCHA no navegador; sem cabeçalho de autenticação. Siga o guia de integração.

Você precisará de acesso ao console administrativo do Bridge em https://admin.bridge.new.Se ainda não tiver acesso, peça ao administrador do Bridge para criar seu usuário.

Gere uma chave de API

Abra o console administrativo

Acesse o painel do Bridge e entre com suas credenciais.

Acesse as chaves de API

No painel esquerdo, acesse Developers → API Keys Management.

Crie uma nova chave

Clique em Generate New Key. Você pode definir um nome descritivo e uma data de expiração.

Importante:
A chave de API será exibida apenas uma vez, no momento da criação. Copie-a imediatamente e guarde-a em um local seguro: você não poderá consultá-la depois.

Use sua chave de API

Inclua a chave da API REST no cabeçalho x-api-key em toda requisição ao host da API REST de integrações:

curl -X GET "https://api-connect-us.bridge.new/bridge/api/health" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch("https://api-connect-us.bridge.new/bridge/api/health", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api-connect-us.bridge.new/bridge/api/health",
    headers={"x-api-key": "YOUR_API_KEY"}
)

print(response.json())

Use o endpoint GET /bridge/api/health para verificar se a chave de API é válida e se a conexão está funcionando.

Boas práticas de segurança

Use variáveis de ambiente — Armazene a chave de API em uma variável de ambiente, como BRIDGE_API_KEY, em vez de inseri-la diretamente no código-fonte.
Nunca exponha chaves no código do cliente — As chaves de API devem ser usadas somente em aplicações no servidor. Nunca as inclua no frontend, em aplicativos móveis ou em repositórios públicos.
Defina uma data de expiração — Sempre configure a expiração ao criar uma chave. Evite chaves sem prazo definido.
Use uma chave por aplicação — Crie uma chave de API separada para cada serviço ou aplicação que se conecta ao Bridge. Isso limita o impacto de uma chave comprometida.
Faça a rotação das chaves periodicamente — Crie uma nova chave e atualize as aplicações antes de desativar a antiga. Assim, a rotação não interrompe o serviço.

Solução de problemas

Erro	Possível causa	Solução
`401 Unauthorized`	Chave de API inválida, expirada ou ausente	Verifique se a chave está correta, ativa e incluída no cabeçalho `x-api-key`
`403 Forbidden`	A chave de API não tem acesso ao recurso solicitado	Verifique se a chave tem as permissões necessárias para esse endpoint
Não consigo consultar a chave de API	A chave é exibida apenas uma vez, no momento da criação	Gere uma nova chave de API no console administrativo

Para consultar a lista completa, veja a referência de códigos de erro.

Tópicos relacionados

Códigos de erro — Referência completa dos erros da API Bridge
Referência da API REST — Explore os endpoints disponíveis
Webhooks — Configure notificações de eventos em tempo real

Comece aqui

Crie sua integração

Referência

Visão geral

Gere uma chave de API

Use sua chave de API

Boas práticas de segurança

Solução de problemas

Tópicos relacionados