Saltar para o conteúdo
Verificado

Autenticação

Chaves de API de conta, acesso total versus personalizado e onde criar uma.

Cada chamada ao CPI leva uma chave de API. Não há um id de cliente separado, nem handshake OAuth, nem assinatura a calcular: uma chave, enviada com o pedido.

Criar uma chave

As chaves ficam no painel, no ecrã Programadores do menu da conta, no separador Chaves de API. Um projeto tem o seu próprio separador API, que cria o mesmo tipo de chave já limitada a esse projeto, pelo que nunca precisa de escrever um app_id manualmente. A sandbox da referência da API interativa também pode criar uma na hora, para que experimente um método antes de ligar fosse o que fosse ao seu próprio código.

Verificação de identidade

Criar uma chave de API exige verificação de identidade, a mesma verificação de nível 2 que a Xuda pede antes de atribuir um número de telefone, uma caixa de correio ou um IP portátil. Uma conta sem nada verificado vê um pedido de verificação antes de o formulário da chave abrir.

Âmbito: como que conta atua a chave

Uma chave é criada com um de três âmbitos e atua sempre na conta ou na aplicação para a qual foi criada:

  • Conta: atua diretamente na sua conta, como faria numa sessão iniciada no painel. Chega a todos os métodos a que uma chave de conta simples chega.
  • Aplicação: criada a partir do separador API do próprio projeto, fixada ao app_id desse projeto.
  • Full Stack VPS: emitida automaticamente quando aprovisiona um VPS Full Stack, limitada aos grupos de capacidades escolhidos na criação. Consulte VPS Full Stack para ver o que abrange.

Acesso: total ou personalizado

Cada chave também escolhe quanto da superfície pública consegue alcançar:

  • Acesso total: tudo o que a conta pode fazer através da API, incluindo métodos adicionados depois de a chave ter sido criada. Os métodos privados ficam sempre excluídos: private: true é um muro rígido, verificado em cada chamada, não um valor predefinido que o acesso total substitua.
  • Acesso personalizado: uma lista de permissões explícita que constrói marcando métodos no formulário da chave, agrupados por microserviço, com os campos de cada método visíveis na própria linha. Um método adicionado mais tarde não é incluído até voltar e o permitir. Um método cuja clearance é public está sempre acessível, mesmo por uma chave personalizada sem nada marcado, uma vez que um método público não precisa de sessão nem de entrada na lista de permissões.
Os métodos do api_module são apenas de sessão

Os métodos que criam, atualizam e listam chaves de API (create_account_api_key, get_app_api_keys e o resto do api_module) nunca são acessíveis com uma chave de API, por conceção: uma credencial não pode criar nem editar credenciais da conta com que se autentica. Gira as chaves a partir do painel ou de uma sessão iniciada.

Enviar a chave

Em REST simples, a chave é mais um parâmetro do pedido, chamado api_key: um campo no corpo JSON em POST, um parâmetro da query string em GET. Consulte Chamar um método para ambas as formas.

cURL
curl -s https://xuda.ai/cpi/get_account_projects \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'

Em MCP, a mesma chave vai num cabeçalho Authorization: Bearer; não há campo api_key. Consulte MCP.

claude mcp add
claude mcp add --transport http xuda https://xuda.ai/mcp \
  --header "Authorization: Bearer YOUR_API_KEY"
Mantenha-a no servidor

Uma chave de API é uma credencial de portador: quem a possui atua como a sua conta. Nunca a inclua em código do lado do cliente, nunca a envie para um repositório nem a cole numa captura de ecrã partilhada. Substitua a chave de imediato se alguma vez aparecer num desses locais; substituir mantém o nome e o modo de acesso e revoga o valor antigo no mesmo passo.

Seguinte