Yapture Studio
Sign in

Authentication

API Key Types

ysk_prov_*

Provider API Key

Issued on approval. Scoped to your own listing and members. Use this in your SDK client and CI/CD pipelines.

ysk_svc_*

Service Token

Admin-level access for Yapture internal tooling. Not issued to providers.

Getting Your API Key

  1. 1 Submit a provider interest form
  2. 2 Verify your email
  3. 3 Wait for admin approval
  4. 4 Receive your API key in the approval notification (shown once, store securely)

Environment Setup

# .env (do NOT commit this file)
YAPTURE_STUDIO_API_KEY=ysk_prov_a1b2c3d4e5f6...
import { StudioClient } from '@yapture/studio-sdk';

const client = new StudioClient({
  apiKey: process.env.YAPTURE_STUDIO_API_KEY,
});

Key Rotation

Generate additional keys via the API. Each key is returned in plaintext only once on creation.

curl -X POST https://studio-registry.example.invalid/provider/studio/api-keys \
  -H "Authorization: Bearer ysk_prov_current_key" \
  -H "Content-Type: application/json" \
  -d '{"label": "CI/CD key"}'

# Response:
# {
#   "id": "key_abc",
#   "key": "ysk_prov_new_key_here",
#   "label": "CI/CD key",
#   "note": "Store this key securely. It will not be shown again."
# }

Security

  • Keys are stored as SHA-256 hashes — Yapture cannot retrieve your raw key
  • The raw key is returned once on creation; store it in a secrets manager
  • Keys are scoped to your provider — they cannot access other providers' data
  • Revoke compromised keys via GET /provider/studio/api-keys + deactivation