As API Keys são credenciais que autenticam e autorizam acesso à API ConnectVets Notes.
Importante: O acesso à API ConnectVets Notes é exclusivo do plano Enterprise. Entre em contato conosco via Discord para verificar sua elegibilidade e configurar seu acesso.

​
Como Funcionam

1

Verificação de Elegibilidade

Confirme que você é cliente do plano Enterprise - apenas clientes Enterprise têm acesso à API
2

Solicitação

Contate nossa equipe via Discord para solicitar acesso
3

Configuração Personalizada

Nossa equipe criará suas credenciais com limites de rate limiting personalizados para seu uso
4

Entrega Segura

Você receberá sua API Key, informações sobre seus limites específicos e instruções de uso
5

Integração

Use a chave no header X-API-KEY em todas as requisições

​
Tipos de API Keys

​
Produção (Enterprise)

  • Ambiente: https://api-sandbox.connectvets.com.br/notes/v1
  • Uso: Aplicações em produção (clientes Enterprise)
  • Rate Limiting: Limites personalizados conforme necessidade do cliente
  • Suporte: Prioritário e dedicado

​
Homologação (Enterprise)

  • Ambiente: https://api-sandbox.connectvets.com.br/notes/v1
  • Uso: Testes e homologação (clientes Enterprise)
  • Rate Limiting: Limitado para ambiente de testes
  • Suporte: Via Discord

​
Configuração

​
Headers Obrigatórios

X-API-KEY: sua_api_key_aqui
Content-Type: application/json

​
Exemplo de Uso

const apiKey = process.env.CONNECTVETS_API_KEY;

const response = await fetch('https://api-sandbox.connectvets.com.br/notes/v1/notes', {
  method: 'GET',
  headers: {
    'X-API-KEY': apiKey,
    'Content-Type': 'application/json'
  }
});

​
Limites e Cotas

Plano Enterprise Obrigatório: O consumo da API ConnectVets Notes é exclusivo para clientes do plano Enterprise.
Os limites de rate limiting são configurados individualmente para cada cliente Enterprise baseado em:
  • Volume de uso esperado
  • Tipo de integração
  • Criticidade da aplicação
  • Horários de pico
Para conhecer seus limites específicos, entre em contato com nossa equipe via Discord.

​
Monitoramento

​
Headers de Resposta

A API retorna informações sobre uso nos headers: 
X-RateLimit-Limit-Minute: 100
X-RateLimit-Remaining-Minute: 87
X-RateLimit-Reset-Minute: 1642694400
X-RateLimit-Limit-Hour: 1000
X-RateLimit-Remaining-Hour: 756

​
Dashboard (Em Breve)

Estamos desenvolvendo um dashboard para acompanhamento em tempo real:
  • Uso de cotas em tempo real
  • Histórico de requisições
  • Alertas de limite
  • Estatísticas de performance

​
Segurança

Nunca exponha sua API Key em código público, logs ou URLs. Use variáveis de ambiente.

​
Boas Práticas

  1. Variáveis de Ambiente 
    export CONNECTVETS_API_KEY="sua_api_key_aqui"
  2. Rotação Regular
    • Contate nossa equipe via Discord para rotacionar chaves periodicamente
    • Especialmente importante após vazamentos ou mudanças de equipe
  3. Monitoramento
    • Acompanhe logs de acesso e uso
    • Configure alertas para uso anômalo
  4. Segregação
    • Use chaves diferentes para desenvolvimento e produção
    • Limite permissões por ambiente

​
Troubleshooting

​
Erro 401: Unauthorized

{
  "error": "unauthorized",
  "message": "Invalid or missing API key"
}
Soluções:
  • Verifique se o header X-API-KEY está presente
  • Confirme que a chave está correta
  • Verifique se a chave não expirou

​
Erro 403: Forbidden

{
  "error": "forbidden", 
  "message": "Insufficient permissions for this endpoint"
}
Soluções:
  • Verifique se sua chave tem permissões para o endpoint
  • Contate nossa equipe via Discord para upgrade de plano

​
Erro 429: Rate Limit

{
  "error": "too_many_requests",
  "message": "Rate limit exceeded",
  "retry_after": 60
}
Soluções:
  • Implemente retry com backoff exponencial
  • Considere upgrade para plano com limite maior
  • Otimize frequência de requisições

​
Gerenciamento

Importante: API Keys não são gerenciadas via API. Todas as operações são feitas através de contato direto com nossa equipe via Discord.

​
Para Solicitar Nova Chave

Pré-requisito: Você deve ser cliente do plano Enterprise para ter acesso à API.
  1. Contate via Discord: https://discord.gg/uN4NxUGk
  2. Informe:
    • Nome da empresa/projeto (cliente Enterprise)
    • Casos de uso esperados
    • Volume estimado de requisições
    • Ambiente (produção/desenvolvimento)
    • Necessidades específicas de rate limiting

​
Para Modificar Limites

Como cliente Enterprise, você pode solicitar ajustes nos seus limites de rate limiting. Entre em contato via Discord informando:
  • Justificativa técnica para o ajuste
  • Métricas de uso atual da API
  • Projeções de crescimento de tráfego
  • Impacto nos negócios dos limites atuais

​
Para Renovar ou Revogar

Nossa equipe pode ajudar com:
  • Renovação de chaves expiradas
  • Revogação por segurança
  • Migração entre ambientes
Próximo passo: Explore os endpoints de Notes ou veja exemplos de autenticação.