API v1.0

開発者向けAPI

SignaGeniusを既存のワークフローに統合します。REST APIを使用すると、チームメンバーをプログラムで管理し、同期をトリガーし、リアルタイムの分析を取得できます。

認証

すべてのAPIリクエストはBearerトークンを使用して認証する必要があります。APIキーは管理パネル > 設定 > 開発者で生成できます。

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://panel.signagenius.com/api/v1/users

エンドポイント

GET/users

すべてのチームメンバーとその署名ステータスを一覧表示します。

スコープ: users:read?limit=1...200?offset=0...1000000
POST/users

管理対象のワークスペース ユーザーを作成します。

スコープ: users:write
GET/users/{id}

テナント内の管理対象ユーザーを 1 件取得します。

スコープ: users:read
PATCH/users/{id}

対応しているプロフィール項目やアカウントの状態を更新します。

スコープ: users:write
DELETE/users/{id}

監査履歴を残したままユーザーをソフト無効化します。

スコープ: users:write
POST/users/batch

最大 100 ユーザーの作成・更新・無効化を、行ごとの結果とべき等な再実行つきで行います。

スコープ: users:writeheader: Idempotency-Key
GET/signatures

生成された署名成果物のうち、新しい順に 200 件を一覧します。

スコープ: signatures:read?user_id
GET/change-requests

管理対象のプロフィール変更リクエストを一覧します。

スコープ: requests:read?status=pending|approved|rejected
GET/analytics

特定の期間のリンククリック分析を取得します。

スコープ: analytics:read?days=1...365
GET/audiences

再利用できるキャンペーン オーディエンスと、解決済みのメンバーを一覧します。

スコープ: audiences:read
POST/audiences

API 管理のオーディエンスを作成、またはべき等に置き換えます。

スコープ: audiences:write
GET/audiences/{id}

オーディエンス 1 件を、解決済みのメンバーとともに取得します。

スコープ: audiences:read
PUT/audiences/{id}

オーディエンスとそのメンバー全体を置き換えます。

スコープ: audiences:write
DELETE/audiences/{id}

再利用できるオーディエンスを削除します。

スコープ: audiences:write
GET/webhooks

署名付きの Webhook サブスクリプションを、シークレットを除いて一覧します。

スコープ: webhooks:write
POST/webhooks

サブスクリプションを作成し、署名用シークレットを一度だけ受け取ります。

スコープ: webhooks:write
PATCH/webhooks/{id}

Webhook サブスクリプションを更新・有効化・一時停止します。

スコープ: webhooks:write
DELETE/webhooks/{id}

Webhook サブスクリプションを削除します。

スコープ: webhooks:write
GET/export

ワークスペース構成のバージョン付きエクスポートを、認証情報・シークレット・イベント履歴・再生成可能な成果物を除いてダウンロードします。

スコープ: exports:read

助けが必要ですか?

私たちのエンジニアリングチームが統合のお手伝いをします。

サポートに連絡