Visão Geral da API e Autenticação

Começando com a API REST do ExCoil: autenticação, limites de taxa, tratamento de erros e configuração de URL base.

1. URL Base

Todos os endpoints da API são servidos sob:

https://excoil.net/api/v1/

Todas as requisições e respostas usam formato JSON. Defina o cabeçalho Content-Type como application/json para requisições POST.

2. Autenticação

Autentique usando um token Bearer no cabeçalho Authorization:

Authorization: Bearer exk_your_api_key_here

Chaves API são geradas na página de Chaves API no seu dashboard. Veja o guia de Gerenciamento de Chaves API para detalhes.

3. Endpoints Disponíveis

Método	Endpoint	Descrição
GET	/health	Verificação de saúde da API
GET	/refrigerants	Listar refrigerantes disponíveis
POST	/calculate/chilled-water	Cálculo de serpentina de água gelada
POST	/calculate/hot-water	Cálculo de serpentina de água quente
POST	/calculate/steam-coil	Cálculo de serpentina a vapor
POST	/calculate/dry-cooler	Cálculo de dry cooler
POST	/calculate/dx-evaporator	Cálculo de evaporador DX
POST	/calculate/dx-evaporator/balanced	Evaporador DX com balanço energético
POST	/calculate/dx-condenser	Cálculo de condensador DX
POST	/calculate/dx-condenser/balanced	Condensador DX com balanço energético

4. Formato de Resposta

Respostas bem-sucedidas retornam:

{ "success": true, "data": { ... } }

Respostas de erro retornam:

{ "error": "error_code", "message": "Human-readable description" }

5. Códigos de Status HTTP

Código	Significado	Quando
200	OK	Cálculo bem-sucedido
400	Bad Request	Parâmetros de entrada inválidos
401	Unauthorized	Chave API ausente ou inválida
403	Forbidden	Chave não possui permissão necessária
422	Unprocessable	Erro de cálculo (ex: solver não convergiu)
429	Too Many Requests	Limite de taxa excedido

6. Início Rápido

Exemplo usando curl:

curl -X POST https://excoil.net/api/v1/calculate/chilled-water \ -H "Authorization: Bearer exk_your_key" \ -H "Content-Type: application/json" \ -d '{ "air": { "T_db": 35, "T_wb": 24 }, ... }'

Veja o guia de Endpoints de Cálculo para exemplos completos de requisição/resposta para cada tipo de calculadora.