Install and verify

Before you start

• node: >=18.0.0.

Use a project with a package.json. Check the runtime and package manager:

1node --version
2npm --version

Install the documented version

1npm install @qentrah/sdk@3.0.0-beta.31

Confirm the installation

1npm ls @qentrah/sdk

The output should show @qentrah/sdk@3.0.0-beta.31. Commit the lockfile so another developer installs the same dependency tree.

Quick start

1import { createClient } from '@qentrah/sdk'
2 
3const qentrah = createClient({
4  url: 'https://cms.example.com',
5  apiKey: process.env.QENTRAH_API_KEY,
6})
7 
8const { data, meta } = await qentrah.content.list({
9  limit: 20,
10  status: 'published',
11})

Authenticate with JWT credentials when an API key is not available:

1const qentrah = createClient({ url: 'https://cms.example.com' })
2await qentrah.auth.login({ email: 'admin@example.com', password: 'secret' })

Expected result

A configured client sends requests to your running CMS. Replace cms.example.com with your own server; installation does not start or deploy a CMS.