Skip to Content
Getting StartedQuickstart

Quickstart

This guide walks you from zero to your first authenticated API call in five minutes.

1. Create a workspace

Sign up at app.asiri.ng  and create a workspace. Every API request is scoped to a workspace (tenant) — see Concepts → Tenants for the model.

2. Mint an API key

In the dashboard, go to Settings → API Keys → New Key. Pick the scopes you need (least privilege wins). For this quickstart, choose reports:read. Copy the secret value. We display the secret exactly once — store it in your secret manager. Details: API Keys.

3. Make a request

export ASIRI_API_KEY="asiri_live_..."   # paste once, then reference
 
curl https://api.asiri.ng/v1/reports/overview \
  -H "Authorization: Bearer $ASIRI_API_KEY"

A 200 OK with a data object confirms the key is valid, the reports:read scope is granted, and the request reached your workspace.

4. Wire up the SDK

If you’re on TypeScript or Node, @asiri-ng/sdk-ts ships typed clients for every public endpoint:

import { AsiriError, createAsiriClient } from '@asiri-ng/sdk-ts';
 
const asiri = createAsiriClient({
  baseUrl: 'https://api.asiri.ng',
  apiKey: process.env.ASIRI_API_KEY,
});
 
const { data, error, response } = await asiri.GET('/v1/reports/overview');
if (error) {
  throw AsiriError.from(error, response.status);
}
 
console.log(data);

See SDKs → TypeScript for installation and full usage.

Python teams can use asiri-sdk with the same API key:

from asiri import AsiriClient
 
asiri = AsiriClient(base_url="https://api.asiri.ng", api_key="asiri_live_...")
print(asiri.get("/v1/reports/overview"))

Next steps

Production ReadyConsent banner