HALCYONDEVELOPER DOCS
Suporte ↗

DESENVOLVIMENTO / REST

Referência da API

REST, autenticação, contratos versionados e catálogo de endpoints da Halcyon Platform.

API v1 · Alpha. Referência baseada no contrato OpenAPI existente na Halcyon Platform. O catálogo documenta caminhos e parâmetros, mas não significa que todos os serviços sejam públicos, estejam licenciados ou tenham feed operacional em cada ambiente.

Como funciona

A API utiliza REST e JSON. O URL base indicado pelo contrato é https://terminal.halcyonterminal.app. O Terminal é um cliente da plataforma; integrações externas devem respeitar autorização, limites de utilização e direitos de dados.

Shell · metadados
curl --request GET \
  --url https://terminal.halcyonterminal.app/api/v1/health \
  --header 'Accept: application/json'

Autenticação

O contrato documenta o cabeçalho X-Halcyon-API-Key para acessos institucionais autorizados e X-Halcyon-User-Token para sessões de utilizador quando aplicável. Nem todos os recursos usam o mesmo esquema: confirme o requisito de cada operação na especificação e com a equipa responsável.

Shell · exemplo de credencial institucional
curl --request GET \
  --url https://terminal.halcyonterminal.app/api/v1/entities/search?q=angola \
  --header 'Accept: application/json' \
  --header "X-Halcyon-API-Key: $HALCYON_API_KEY"

Segurança: guarde a chave em variáveis de ambiente ou cofres institucionais. Não a exponha em páginas públicas, aplicações client-side ou commits. Os exemplos são ilustrativos e não executam requisições a partir desta documentação.

OpenAPI e contratos

Esta cópia acompanha o documento OpenAPI 3.1 / 1.0.0-alpha presente no repositório do Terminal à data desta publicação. Serve para leitura e integração autorizada; uma revisão posterior deverá confirmar divergências entre o documento e cada ambiente.

YAML · OPENAPI 3.1Descarregar especificação →Contrato actual com 44 caminhos documentados.SDKExemplo Python →Cliente Python existente no repositório, distribuição inicial.
44 CAMINHOS

Nenhum endpoint corresponde à pesquisa.

Plataforma & metadados

GET
/api/v1/healthPlatform health
GET
/api/v1/cloud/healthHalcyon Cloud dependency health
GET
/api/v1/platformPlatform capabilities and professional areas
GET
/api/v1/domainsCanonical Halcyon platform domains
GET
/api/v1/contractsCanonical Halcyon service contract registry
GET
/api/v1/developer/capabilitiesDeveloper integration surfaces
GET
/api/v1/integration/statusHalcyon Integration Fabric operational status
GET
/api/v1/events/feedAuthenticated Halcyon Platform event feed

Finanças

GET
/api/v1/finance/instrumentsAngola fixed-income master universe
GET
/api/v1/finance/inplay/snapshotSchwab-backed Stocks In Play market-intelligence snapshot

Energia, electricidade & água

GET
/api/v1/energy/marketsEnergy market benchmarks and history
GET
/api/v1/energy/fuels/modelAngola downstream fuel sensitivity model
GET
/api/v1/energy/concessionsAngola canonical petroleum concession registry
GET
/api/v1/power/gridAngola public power-grid intelligence
GET
/api/v1/power/marketAngola and SAPP power-market intelligence
GET
/api/v1/power/sapp-marketSAPP public market-depth intelligence
GET
/api/v1/power/statisticsRNT public system statistics
GET
/api/v1/power/hydroAngola hydro-meteorological power context
GET
/api/v1/power/hazardsAngola public power hazard context
GET
/api/v1/water/publicAngola Water & Sanitation public intelligence

Marítimo, entidades & media

GET
/api/v1/media/channelsHTV live media source catalogue
GET
/api/v1/maritime/aisMaritime AIS intelligence service
GET
/api/v1/entities/graphCanonical Halcyon entity graph
GET
/api/v1/entities/searchSearch canonical Halcyon entities

Rede & telecomunicações

GET
/api/v1/network/overviewNetwork operational overview
GET
/api/v1/network/sitesNetwork sites
GET
/api/v1/network/incidentsNetwork incidents
GET
/api/v1/network/metricsNetwork metrics
GET
/api/v1/network/linksNetwork links
GET
/api/v1/network/servicesNetwork services
GET
/api/v1/network/maintenanceNetwork maintenance
GET
/api/v1/network/dependenciesService-to-resource dependency graph
GET
/api/v1/network/alarmsNetwork alarms
GET
/api/v1/network/incident-eventsIncident operational timeline
GET
/api/v1/network/forecastsNetwork capacity forecasts
GET
/api/v1/telecom/productsTelecom strategic product catalog and interoperability surfaces
GET
/api/v1/telecom/ntn/sessionsLEO / NTN / Direct-to-Device session view
GET
/api/v1/telecom/ai-networks/recommendationsAI Networks recommendations
GET
/api/v1/telecom/ai-business/agentsEnterprise AI agent catalog
GET
/api/v1/telecom/ai-business/statusMercury AI provider and safety status
POST
/api/v1/telecom/ai-business/queryInvoke Mercury AI / Enterprise AI gateway
GET
/api/v1/telecom/cyber/eventsAI Cybersecurity event triage
GET
/api/v1/telecom/private-5g/networksPrivate 5G / 5G-Advanced network inventory
GET
/api/v1/telecom/iot/assetsIndustrial IoT and Edge asset registry

Erros, estados e disponibilidade

Respostas podem incluir erros HTTP como 400, 401, 403, 429, 502 ou 503, consoante o recurso. Dados em demonstração, indisponibilidade de fornecedor, permissões e quotas devem ser tratados separadamente de dados confirmados.