Smart reporting
Granular roles keep sensitive work private while everyone else stays informed. Automations take care of the repetitive steps, so people can focus on real work.
Overview
Our team has done this many times, so you never have to guess. Start in minutes and get help from a real person whenever you need it. Clear reports turn weekly numbers into decisions in minutes, not days. Start free, upgrade when you grow and cancel any time with one click.
Installation
Install the SDK with the package manager your project already uses. It needs Node 18 or newer.
$ npm install @yaraen-craft/sdk$ yarn add @yaraen-craft/sdk$ pnpm add @yaraen-craft/sdkConfiguration
Teams report saving around five hours a week after the first month. We measure success by how many customers come back and tell their friends. Create a file named yaraen-craft.config.json in the project root:
{
"project": "yaraen-craft",
"region": "us-east",
"categories": ["product", "engineering", "marketing"],
"retries": 5,
"timeoutMs": 13000,
"webhooks": { "enabled": true }
}| Option | Type | Default | Description |
|---|---|---|---|
project | string | - | Your project key from the dashboard. |
region | string | "us-east" | Data centre closest to your customers. |
retries | number | 3 | How often a failed call is retried. |
timeoutMs | number | 10000 | Time before a request is cancelled. |
webhooks.enabled | boolean | false | Send events to your endpoint. |
Your first request
Set up in an afternoon, connect the tools you use and invite your team.
- Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
- Store it safelyKeep the key in an environment variable, never in your source code.
- Make the callRun the snippet below; it prints the first page of results.
import { Client } from "@yaraen-craft/sdk";
const client = new Client({ apiKey: process.env.API_KEY });
// list the newest plans in one category
const page = await client.plans.list({ category: "product", limit: 20 });
for (const item of page.data) {
console.log(item.name, item.price);
}API reference
Every endpoint returns JSON and uses standard HTTP status codes.
/v1/plansList plans with paging and filters./v1/plansCreate a new plan./v1/plans/{id}Update some fields of a plan./v1/plans/{id}Archive a plan; it can be restored for 30 days.{
"data": [
{ "id": "plan_6854", "name": "Automation pack", "price": 232 }
],
"has_more": true
}Troubleshooting
Next steps
Start free, upgrade when you grow and cancel any time with one click.