スポットワーク Open API ポータル

この API でできること

スポットワーク Business API は、企業向け管理機能を外部システムから利用するための API です。 案件、フォーマット、スケジュール、ワーカー、レビュー、Webhook などを連携し、 社内ツールや基幹システムと接続する用途を想定しています。

このポータルでは、OpenAPI 定義の確認、モックレスポンスでの動作検証、 実 API への疎通確認、Webhook の送受信確認を行えます。

本番環境での利用開始前に必要なこと

1. admin.spotwork.biz にログインします。
2. 対象企業ページの下部にある API 設定ページを開きます。
3. API キーを発行し、必要な権限スコープを設定します。
4. 発行した API キーを本番環境で使います。
5. 本番環境のURLはhttps://open-api.spotwork.biz/v1 です。

API キーは発行後に安全な場所で管理してください。検証用と本番用は分ける前提で運用するのが安全です。

このポータルの見方

• API 検証: OpenAPI の operation ごとに request を編集し、mock または実 API を確認します。
• Webhook: 任意 URL に対してイベント payload を送信し、受信系の疎通を確認します。
• Swagger: 仕様書を一覧で確認します。
• OpenAPI YAML: API 仕様の確認に利用します。

API 検証の進め方

1. モックサーバーのURLはhttps://spotwork-open-api-portal.spotwork.biz/v1 です。直接 request を送り、検証を進められます。
2. ポータル上の API 検証タブでは、operation ごとに request / response の shape を確認できます。
3. 必要に応じてエラーシナリオを切り替え、連携先の異常系ハンドリングを検証します。
4. 必要になった段階で、実 API に対する疎通や認証設定を確認します。

Folders_download は zip ではなく manifest JSON を返します。 ファイル実体は downloadPath を使って個別に取得します。

Webhook の位置づけ

Webhook は、注文や作業、メッセージの変化を外部システムへ通知するための仕組みです。 API で定期取得するだけでなく、Webhook を併用することで状態変化を即時に受け取れます。

まずこのポータルで payload を確認し、次に実際の受信サーバーへ送信して、 署名検証やイベント処理が期待通りに動くかを確認してください。

運用上の注意

• 本番キーをフロントエンドへ直接埋め込まないでください。
• 用途に応じて最小権限のスコープを設定してください。
• 変更系 API は idempotency key や retry 方針も含めて設計してください。