Como Integrar com as APIs Toolzz

Este guia vai te mostrar, de forma simples, como integrar os produtos Toolzz nas suas aplicações.

Autenticação

Todas as APIs Toolzz utilizam autenticação via token Bearer. Basta incluir sua chave de API no cabeçalho Authorization:
Authorization: Bearer SUA_API_KEY
Para obter sua chave de API, entre em contato com nosso suporte: contato@toolzz.me

Padrões da API

Nossas APIs seguem o padrão REST e utilizam os métodos HTTP mais comuns:
  • GET - Buscar informações
  • POST - Criar novos dados
  • PUT - Atualizar dados existentes
  • DELETE - Remover dados

Formato das Respostas

Todas as respostas das APIs são em formato JSON e trazem códigos de status padrão:
{
  "success": true,
  "data": {
    // Dados da resposta
  },
  "message": "Operação realizada com sucesso"
}

Limite de Requisições (Rate Limiting)

Para garantir a estabilidade do serviço, nossas APIs possuem limites de requisições:
  • Plano Padrão: 100 requisições por minuto
  • Plano Consultivo: Limites personalizados

Boas Práticas

  1. Tratamento de Erros
    • Sempre trate erros de forma adequada
    • Verifique os códigos de status das respostas
    • Registre informações relevantes sobre erros
  2. Segurança
    • Nunca exponha suas chaves de API
    • Use variáveis de ambiente
    • Valide todas as requisições recebidas
  3. Performance
    • Faça cache das respostas quando possível
    • Implemente tentativas automáticas (retry) em caso de falha
    • Use paginação para grandes volumes de dados

Suporte

Se precisar de ajuda com a integração:
  • E-mail: contato@toolzz.me
  • Documentação: Consulte os guias específicos de cada produto
  • Status: Acompanhe o status do sistema