Chaves API

As Chaves API são essenciais para integrar e usar os serviços da plataforma SipPulse AI de forma programática. Elas permitem autenticar requisições de API e acessar modelos de geração de texto, texto para fala, fala para texto e agentes a partir de suas próprias aplicações.

Criando Chaves API

Para gerar uma nova Chave API:

1. Navegue até Chaves API no menu lateral
2. Clique no botão Gerar Chave API
3. Digite um nome descritivo para a chave API (ex.: "Servidor Produção", "Desenvolvimento", "App Mobile")
4. Clique em Criar
5. Importante: Copie e salve a chave API imediatamente - ela será exibida apenas uma vez

WARNING

A chave API completa é mostrada apenas uma vez no momento da criação. Armazene-a de forma segura em um gerenciador de senhas ou variável de ambiente. Se você perdê-la, precisará criar uma nova chave.

Limite de Chaves API

Cada conta pode ter até 20 chaves API ativas. Isso permite usar diferentes chaves para diversos projetos, ambientes ou membros da equipe.

Gerenciando Chaves API

Visualizando Chaves

A página de Chaves API exibe todas as suas chaves com as seguintes informações:

• Nome: O nome descritivo que você atribuiu
• Chave: Uma dica mascarada mostrando os últimos 4 caracteres
• Criada em: Quando a chave foi criada
• Último uso: Quando a chave foi usada pela última vez em uma requisição de API
• Custo (30d): Custo total das chamadas de API feitas com esta chave nos últimos 30 dias

Renomeando Chaves

Clique no ícone de edição ao lado de uma chave para renomeá-la. Use nomes descritivos para identificar facilmente onde cada chave é usada.

Excluindo Chaves

Clique no ícone de lixeira para excluir uma chave. Uma vez excluída:

• A chave é imediatamente invalidada
• Qualquer aplicação usando esta chave receberá erros de autenticação
• Esta ação não pode ser desfeita

Usando Chaves API

Autenticação

Inclua sua chave API no cabeçalho Authorization de todas as requisições de API:

cURL

curl -X POST https://api.sippulse.ai/v1/chat/completions \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Olá!"}]
  }'

JavaScript

const response = await fetch('https://api.sippulse.ai/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer SUA_CHAVE_API',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'gpt-4o',
    messages: [{ role: 'user', content: 'Olá!' }]
  })
});

const data = await response.json();
console.log(data.choices[0].message.content);

Python

import requests

response = requests.post(
    'https://api.sippulse.ai/v1/chat/completions',
    headers={
        'Authorization': 'Bearer SUA_CHAVE_API',
        'Content-Type': 'application/json'
    },
    json={
        'model': 'gpt-4o',
        'messages': [{'role': 'user', 'content': 'Olá!'}]
    }
)

data = response.json()
print(data['choices'][0]['message']['content'])

Usando com SDK da OpenAI

O SipPulse AI é compatível com o SDK da OpenAI. Basta alterar a URL base:

JavaScript/Node.js

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'SUA_CHAVE_API',
  baseURL: 'https://api.sippulse.ai/v1'
});

const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Olá!' }]
});

Python

from openai import OpenAI

client = OpenAI(
    api_key="SUA_CHAVE_API",
    base_url="https://api.sippulse.ai/v1"
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Olá!"}]
)

Rastreamento de Custos

Novo Recurso

O rastreamento de custos para chaves API foi introduzido na versão 1.11. O histórico de uso anterior a esta versão não está disponível.

A plataforma rastreia o uso e os custos para cada chave API:

• Custo 30 Dias: Exibido diretamente na lista de chaves
• Ver Uso: Clique na ação "Ver Uso" para ver análises detalhadas incluindo:
  • Detalhamento total de custos
  • Gráficos de uso ao longo do tempo
  • Requisições por modelo e tipo
  • Logs de uso detalhados com paginação

Isso ajuda você a monitorar quais aplicações ou integrações estão consumindo mais recursos.

Melhores Práticas de Segurança

Mantenha as Chaves Confidenciais

• Nunca faça commit de chaves API no controle de versão - Use variáveis de ambiente ou gerenciamento de segredos
• Não exponha chaves em código client-side - Chamadas de API devem ser feitas pelo seu servidor
• Use chaves diferentes para ambientes diferentes - Chaves separadas para desenvolvimento, staging e produção

Rotacione Chaves Regularmente

Crie periodicamente novas chaves e elimine as antigas, especialmente se:

• Um membro da equipe sair
• Você suspeitar que uma chave foi exposta
• As chaves estiverem em uso por um período prolongado

Monitore o Uso

Verifique regularmente o dashboard de uso para:

• Identificar picos inesperados de uso
• Detectar potencial acesso não autorizado
• Otimizar seu consumo de API

Desativação Automática

O SipPulse AI pode desativar automaticamente qualquer chave API identificada como divulgada publicamente (ex.: encontrada em repositórios públicos) para proteger sua conta.

Chaves API vs Integrações de Provedores

Recurso	Chaves API	Integrações de Provedores
Propósito	Acessar a API do SipPulse AI	Conectar provedores externos de IA
Quem gerencia	Todos os usuários	Apenas Admin/Owner
Faturamento	Usa créditos SipPulse AI	Direto ao provedor
Caso de uso	Integrar SipPulse AI em seus apps	Usar suas próprias contas de provedores

Para mais informações sobre como conectar suas próprias credenciais de provedores, veja Integrações de Provedores.

Referência da API

Para documentação completa da API incluindo todos os endpoints disponíveis, formatos de requisição/resposta e códigos de erro, visite a Referência da API.