Getting started

Autenticação

Aprenda sobre autenticação com chaves de API e melhores práticas de segurança

Autenticação

O RenderHub usa chaves de API para autenticar requisições. Suas chaves de API garantem acesso seguro à API e permitem que você monitore o uso.

Visão Geral

Todas as requisições da API devem incluir sua chave de API no cabeçalho Authorization usando o esquema Bearer:

Authorization: Bearer SUA_CHAVE_API

Obtendo sua Chave de API

  1. Faça login no seu Dashboard
  2. Navegue até Chaves de API na barra lateral
  3. Clique em Criar Chave de API
  4. Dê um nome descritivo (ex: "Produção", "Desenvolvimento")
  5. Copie a chave imediatamente - ela não será mostrada novamente

Tipos de Chaves

RenderHub oferece dois tipos de chaves de API:

Chaves de Teste

  • Prefixo: rh_test_
  • Ambiente de testes sandbox
  • Sem cobrança
  • Ideal para desenvolvimento e testes

Chaves de Produção

  • Prefixo: rh_live_
  • Ambiente de produção real
  • Cobranças aplicadas
  • Use para aplicações em produção

Usando Chaves de API

cURL

curl -X POST https://renderhub.com/api/v1/render \
  -H "Authorization: Bearer rh_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"mode": "CONVERT", "input_type": "html", "data": "<h1>Test</h1>"}'

Node.js

const axios = require('axios');

const API_KEY = process.env.RENDERHUB_API_KEY;

axios.post('https://renderhub.com/api/v1/render', {
  mode: 'CONVERT',
  input_type: 'html',
  data: '<h1>Test</h1>'
}, {
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  }
});

Python

import os
import requests

API_KEY = os.getenv('RENDERHUB_API_KEY')

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json'
}

data = {
    'mode': 'CONVERT',
    'input_type': 'html',
    'data': '<h1>Test</h1>'
}

response = requests.post(
    'https://renderhub.com/api/v1/render',
    headers=headers,
    json=data
)

Melhores Práticas de Segurança

✅ Faça

  • Armazene chaves em variáveis de ambiente

    export RENDERHUB_API_KEY=rh_live_abc123...
  • Use chaves diferentes para cada ambiente

    • Desenvolvimento → rh_test_
    • Produção → rh_live_
  • Rotacione chaves regularmente

    • Crie uma nova chave
    • Atualize sua aplicação
    • Revogue a chave antiga
  • Use HTTPS sempre

    • Todas as requisições devem usar https://

❌ Não Faça

  • Nunca faça commit de chaves no Git

    // ❌ ERRADO
    const API_KEY = 'rh_live_abc123...';
    
    // ✅ CORRETO
    const API_KEY = process.env.RENDERHUB_API_KEY;
  • Nunca exponha chaves em código cliente

    <!-- ❌ ERRADO - chave visível no navegador -->
    <script>
      const apiKey = 'rh_live_abc123...';
    </script>
  • Nunca compartilhe chaves publicamente

    • Não poste em fóruns, tickets de suporte ou logs públicos

Gerenciando Chaves

Listar Chaves

Veja todas as suas chaves ativas no Dashboard → Chaves de API.

Revogar Chaves

Se uma chave for comprometida:

  1. Vá para Dashboard → Chaves de API
  2. Clique em Revogar na chave comprometida
  3. A chave é imediatamente invalidada
  4. Crie uma nova chave de substituição

Rotação de Chaves

Para rotacionar chaves sem downtime:

  1. Crie uma nova chave de API
  2. Implante código atualizado com a nova chave
  3. Monitore por 24h para garantir que a chave antiga não está mais em uso
  4. Revogue a chave antiga

Códigos de Erro de Autenticação

CódigoErroSolução
401missing_authorizationAdicione o cabeçalho Authorization
401invalid_api_keyVerifique se a chave está correta
401revoked_api_keyA chave foi revogada, crie uma nova
403insufficient_permissionsA chave não tem permissão para esta ação

Monitoramento de Uso

Cada chave de API rastreia:

  • Total de requisições por período
  • Requisições bem-sucedidas vs falhas
  • Consumo de quota mensal
  • Última requisição timestamp

Acesse Dashboard → Uso para métricas detalhadas.

Próximos Passos

On this page