Primeiros Passos

Bem-vindo à GoatRealm. Configure seu ambiente e realize sua primeira integração em menos de 5 minutos.

Instalação do SDK

Instale nossa biblioteca oficial via NPM ou Yarn:

bash

npm install @goatrealm/sdk-ts
# ou
yarn add @goatrealm/sdk-ts

Inicialização do Cliente

Importe o cliente e configure sua chave de API (disponível no Dashboard):

typescript

import { GoatClient } from "@goatrealm/sdk-ts";

const goat = new GoatClient({
  apiKey: process.env.GOATREALM_API_KEY, // nunca hardcode
  region: "br-1", // ou "eu-1", "us-1"
});

Primeira Requisição

Teste a conexão consultando o status da API:

typescript

const status = await goat.status.get();

console.log(status);
// {
//   healthy: true,
//   region: "br-1",
//   api_version: "v3.4.0"
// }

Aviso importante

Nunca insira sua chave de API diretamente no código-fonte. Utilize variáveis de ambiente (.env) e garanta que o arquivo não seja commitado no repositório.