Phosra Developer SDK

npm install @phosra/sdk @openchildsafety/ocss

import { PhosraClient } from "@phosra/sdk";

// Server-to-server: a phosra_ API key → sent as the X-Api-Key header.
// Sandbox-first: the baseUrl alone (no key) returns 201 against the open sandbox.
const phosra = new PhosraClient({
  baseUrl: "https://phosra-api-sandbox-production.up.railway.app/api/v1", // open sandbox — no key
});

// Production: drop baseUrl (defaults to prod) and pass a phosra_ API key → X-Api-Key.
// const phosra = new PhosraClient({ apiKey: process.env.PHOSRA_API_KEY }); // phosra_live_…

// Parent-app / consumer: a WorkOS access token → sent as Authorization: Bearer.
// const phosra = new PhosraClient({ accessToken: workosAccessToken });

const family = await phosra.families.create({ name: "Acme Household" });
const child  = await phosra.children.create(family.id, { name: "Mia", birth_date: "2013-01-15" });
const policy = await phosra.policies.create(child.id, { name: "Mia — default" });

// Apply a rule (one of the OCSS rule categories — see /ocss/rule-reference)
const rule = await phosra.rules.create(policy.id, {
  category: "addictive_pattern_block",
  enabled: true,
  config: {},
});

const rules = await phosra.rules.list(policy.id);   // read back

const setup = await phosra.setup.quick({
  child_name: "Mia",            // required
  birth_date: "2013-01-15",     // required — YYYY-MM-DD
  strictness: "recommended",    // optional — "relaxed" | "recommended" | "strict" (default: "recommended")
  family_name: "Acme Household", // optional — names a newly-created family
  // family_id: existingFamilyId, // optional — add the child to an existing family instead
});

// Returns the created family, child, policy, every seeded rule, and a summary.
console.log(setup.family.name, setup.age_group, setup.rule_summary.total_rules_enabled);
// Acme Household  teen  16