Skip to content
Plystra Plystra Docs

Developer Handbook

This handbook is split into short, task-focused pages. Start here when you are adding Plystra to an application that already has business objects such as invoices, tickets, orders, documents, cases, or projects.

The examples use the current Core API and SDK behavior in 0.0.1. Use the pages below in order for a complete integration path, or jump directly to the area you are implementing.

Read in Order

Section titled “Read in Order”
  1. Model and Architecture explains what Core stores and where Plystra sits in your production stack.
  2. Local Setup and Super Admin Bootstrap gets Core running and creates the first instance_super_admin.
  3. Authorization Model defines the authz request contract, decision semantics, deny codes, and scope behavior.
  4. Copy-Paste Integration Path walks through a complete invoice.approve setup with concrete HTTP calls.
  5. API Keys and Admin Grants covers machine credentials and human control-plane permissions.
  6. SDK Integration and Error Handling shows the JavaScript, Python, and Go SDK patterns.
  7. Production Checklist and Troubleshooting gives the final checks and common failure modes.

What You Will Build

Section titled “What You Will Build”

By the end of the handbook you will have:

  • a registered resource type and action
  • a Space with Groups
  • a User, Member, and UserMember binding
  • a Role and Permission grant with a safe scope anchor
  • a protected resource
  • an authz.check call that returns explainable allow/deny decisions
  • a production credential strategy using either user sessions or scoped API keys

Credential Rule of Thumb

Section titled “Credential Rule of Thumb”

Use a Bearer access token for user-driven Core admin operations. Use a scoped API key for service-to-service checks and automation. Never put API keys in browser or mobile clients.

Section titled “Related Pages”