A Activatist API Interactive Reference

OpenAPI 3.1 / v0.2.0

API Reference

endpointを検索して、parameters、request body、responses、schema fields、example JSON、raw OpenAPI operationまで確認できます。OpenAPIの英語説明を残し、その下に日本語の補足説明を添えています。

Download openapi.yaml Download openapi.json

Most developers start here

アプリにライセンス認証を組み込む場合、最初に見るendpointはこの3つです。

  • POST /v1/licenses/activate 初回ライセンス入力・端末登録
  • POST /v1/licenses/validate 起動時や定期チェック
  • POST /v1/licenses/deactivate 端末解除

Authentication

  • Public client APIs: seller/admin bearer token不要
  • Seller APIs: verified Firebase bearer token必須
  • Admin APIs: allowlisted admin Firebase identity必須

Runtime License APIs

JavaScriptが読み込めない場合でも、最初に使うruntime APIはこの3つです。seller/admin bearer token は不要です。

  • POST /v1/licenses/validate 起動時や定期チェックで使います。
  • POST /v1/licenses/activate 初回ライセンス入力・端末登録で使います。
  • POST /v1/licenses/deactivate 端末解除で使います。

openapi.yamlを直接見る openapi.jsonを直接見る

Endpoint groups

Public Buyer / Client APIs

  • GET /v1/public/products/{slug}
  • POST /v1/public/products/{slug}/checkout
  • POST /v1/purchases/complete
  • POST /v1/purchases/files/{file_id}/download-intent
  • POST /v1/licenses/activate
  • POST /v1/licenses/validate
  • POST /v1/licenses/deactivate

Seller APIs

  • POST /v1/sellers
  • GET /v1/sellers/me
  • POST /v1/sellers/stripe/account-link
  • POST /v1/products
  • POST /v1/products/{product_id}/submit-review
  • POST /v1/products/{product_id}/files/upload-intent
  • POST /v1/products/{product_id}/files/{file_id}/finalize

Admin APIs

  • GET /v1/admin/sellers
  • PATCH /v1/admin/sellers/{seller_id}/review
  • PATCH /v1/admin/products/{product_id}/review
  • GET /v1/admin/product-files
  • PATCH /v1/admin/products/{product_id}/files/{file_id}/review

Internal / Ops APIs

  • POST /v1/stripe/webhook
  • POST /v1/stripe/connect/webhook
  • GET /healthz
  • GET /readyz

Interactive Referenceが表示されない場合は、openapi.yaml または closed-beta-summary.md を確認してください。販売フローは Seller Quickstart から確認できます。