Pular para o conteúdo principal

​
Visão geral

A API do Devin Desktop permite que clientes corporativos acessem programaticamente análises detalhadas de uso e gerenciem configurações de uso para suas equipes.
A API está disponível apenas nos planos Enterprise

​
URL base

Todas as requisições à API devem ser feitas para: 
https://server.codeium.com/api/v1/

​
Autenticação

A API do Devin Desktop usa chaves de serviço para autenticação. As chaves de serviço devem ser incluídas no corpo da requisição de todas as chamadas à API.

​
Como criar uma chave de serviço

  1. Acesse a página de Configurações da equipe
  2. Vá para a seção “Chaves de serviço”
  3. Crie uma nova chave de serviço com as permissões adequadas
  4. Copie a chave de serviço gerada para usá-la em requisições de API

​
Permissões necessárias

Diferentes endpoints da API exigem permissões diferentes. Consulte a documentação de cada endpoint para identificar a permissão específica necessária:
EndpointPermissão obrigatória
Análises personalizadas (/Analytics)Leitura de análises
Análises da página do usuário (/UserPageAnalytics)Teams: somente leitura
Análises do Cascade (/CascadeAnalytics)Teams: somente leitura
Definir configuração de uso (/UsageConfig)Billing: gravação
Obter configuração de uso (/GetUsageConfig)Billing: leitura
Obter saldo de créditos da equipe (/GetTeamCreditBalance)Billing: leitura

​
Como usar chaves de serviço

Inclua sua chave de serviço no corpo da requisição de todas as chamadas à API: 
{
  "service_key": "your_service_key_here",
  // ... outros parâmetros
}
Mantenha suas chaves de serviço seguras e nunca as exponha em código do lado do cliente ou em repositórios públicos

​
Limites de taxa

As requisições à API estão sujeitas a limites de taxa para garantir a estabilidade do serviço. Se você exceder o limite de taxa, receberá uma resposta 429 Too Many Requests.

​
Suporte

Para obter suporte e esclarecer dúvidas sobre a API, entre em contato com o Suporte do Devin Desktop.