Installation
Install & configure @liqo/sdk
Requirements
- Node.js 18 or newer
- A package manager: npm, pnpm, yarn, or bun
Install
npm install @liqo/sdk
# or
pnpm add @liqo/sdk
# or
yarn add @liqo/sdk
# or
bun add @liqo/sdkImport
// ESM / TypeScript
import { Liqo } from '@liqo/sdk';
// CommonJS
const { Liqo } = require('@liqo/sdk');The package ships type definitions (dist/index.d.ts); no @types package is needed.
Configure your API key
Load your key from the environment:
# .env
LIQO_API_KEY=sk_test_your_key_hereconst liqo = new Liqo(process.env.LIQO_API_KEY!);Add .env to your .gitignore. Never commit API keys.
Peer/runtime notes
- The SDK depends on
axiosand Node's built-incrypto/Buffer. It is a server-side library. - For edge runtimes (Cloudflare Workers, Vercel Edge, Deno, Bun), see examples/RUNTIME_COMPATIBILITY.md.
Verifying the install
import { Liqo } from '@liqo/sdk';
const liqo = new Liqo('sk_test_123', { environment: 'sandbox' });
console.log(liqo.baseUrl); // http://localhost:3000