SDK / JAVASCRIPT

SDK JavaScript

Guia do cliente JavaScript do repositório Halcyon: configuração, pedidos REST e segurança.

Estado e obtenção

O repositório da plataforma contém uma implementação inicial da classe HalcyonClient em sdk/js/index.js. Este pacote não está publicado no npm. O exemplo abaixo pressupõe acesso autorizado ao código-fonte, sem anunciar instalação pública ou um SDK de produção com suporte comercial garantido.

Configuração

O cliente utiliza fetch e o cabeçalho X-Halcyon-API-Key quando configurado. Utilize credenciais somente num backend confiável ou no ambiente institucional autorizado; nunca exponha uma chave privada no JavaScript distribuído no browser.

JavaScript · módulo obtido do repositório

import { HalcyonClient } from "./sdk/js/index.js";

const halcyon = new HalcyonClient({
  baseUrl: "https://terminal.halcyonterminal.app",
  apiKey: process.env.HALCYON_API_KEY || ""
});

const health = await halcyon.health();
const platform = await halcyon.platform();
console.log({ health, platform });

O caminho de importação deve ser adaptado à organização do seu projecto depois de disponibilizar o código-fonte da biblioteca.

Métodos de exemplo

Método	Função
`health()`	Estado da plataforma
`platform()`	Metadados do serviço
`contracts()`	Registo de contratos disponíveis
`developerCapabilities()`	Superfícies de integração
`financeInstruments()`	Instrumentos de renda fixa
`energyMarkets()`	Mercados de energia

Erros e integração

O cliente verifica o estado HTTP da resposta e lança um erro com status e payload quando o serviço rejeita a operação. Implemente timeout, observabilidade e política de novas tentativas conforme o contexto da sua instituição.

JavaScript

try {
  const result = await halcyon.developerCapabilities();
  console.log(result);
} catch (error) {
  console.error("Estado HTTP:", error.status);
}