Plugin Signature Auth

Public SDK usage is plugin-first. Instantiate the client with your plugin id and Ed25519 private key PEM.

const ScrimsAPI = require("./scrims-api");

const scrims = new ScrimsAPI({
  pluginId: process.env.SCRIMS_PLUGIN_ID,
  privateKeyPem: process.env.SCRIMS_PRIVATE_KEY_PEM
});

Manual Key Provisioning (Current)

1. Generate your Ed25519 keypair in your secure environment.
2. Share the public key with the Scrims team for plugin registration.
3. Store your private key PEM in SCRIMS_PRIVATE_KEY_PEM.
4. Use your assigned SCRIMS_PLUGIN_ID when constructing the SDK.

Developer portal-based self-service key provisioning is planned and will replace this manual step.

Generate Reference Docs

Generate TypeDoc output locally:

yarn docs:sdk

Generated files are served from /developers/sdk.