メインコンテンツへスキップ

​
概要

Sanka の REST API はワークスペース単位で動作します。発行したトークンには workspace_id が含まれ、Bearer JWT として利用します。

​
アクセストークンの発行

  1. アプリで Developers → API を開く。
  2. Create Token をクリックし、権限（POST+GET の Full Access / GET のみ Regular）を選択して作成。
  3. 表示された Access Token / Refresh Token を安全な場所に保存（再表示不可）。

​
ベースURL

https://app.sanka.com/

​
認証

すべてのエンドポイントで以下を使用します。 
Authorization: Bearer <access_token>
リフレッシュ: POST /api/token/refresh/ に { "refresh": "<refresh_token>" } を送信。

​
すぐに試す（cURL）

注文一覧: 
curl -X GET "https://app.sanka.com/ja/api/v1/orders/?page=1&amount=30" \
  -H "Authorization: Bearer <access_token>"
アイテム一覧: 
curl -X GET "https://app.sanka.com/ja/api/v1/items" \
  -H "Authorization: Bearer <access_token>"
コンタクト＋会社一覧: 
curl -X GET "https://app.sanka.com/ja/api/v1/contacts" \
  -H "Authorization: Bearer <access_token>"
サブスクリプション作成: 
curl -X POST "https://app.sanka.com/ja/api/v1/subscriptions/create" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{ "cid": "<contact_or_company_id>", "subscription_status": "active", "items": [{ "id": "<item_id>", "amount": 1 }], "currency": "JPY" }'
請求書作成: 
curl -X POST "https://app.sanka.com/ja/api/v1/invoices/create" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{ "cid": "<contact_or_company_id>", "status": "scheduled", "items": [{ "id": "<item_id>", "amount": 1 }], "currency": "JPY" }'
トークン更新: 
curl -X POST "https://app.sanka.com/ja/api/token/refresh/" \
  -H "Content-Type: application/json" \
  -d '{ "refresh": "<refresh_token>" }'

​
APIリファレンス

Developers タブ内の OpenAPI ベースの API Reference で試せます。実行時は Authorization: Bearer <token> を設定してください。