API de Viabilidade
Documentação para integração com o sistema de viabilidade FTTH da ST1.
Visão geral
API para consultar a viabilidade de atendimento FTTH a partir de uma coordenada geográfica.
A viabilidade considera a localização das caixas (CTOs), a distância e as portas de splitter disponíveis, com base nos dados do OZmap.
Base URL: https://SEU-HOST/api/v1
Autenticação
Toda requisição exige uma API key emitida no painel Admin. Envie no header:
x-api-key: ozk_xxxxxxxxxxxxxxxxxxxxxxxxAlternativamente: Authorization: Bearer ozk_…. Requisições sem chave válida retornam 401.
POST
GET
/api/v1/viabilityConsulta a viabilidade para uma coordenada.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| lat | number | sim | Latitude (-90 a 90) |
| lng | number | sim | Longitude (-180 a 180) |
| radius | number | não | Raio de busca em metros |
Códigos de status
| Código | Significado |
|---|---|
| 200 | Consulta realizada com sucesso. |
| 400 | Parâmetros inválidos (lat/lng ausentes ou fora de faixa). |
| 401 | API key ausente, inválida ou revogada. |
| 502 | Falha ao consultar o OZmap. |