外部システム連携
VeriCerts Zero APIを外部システムから利用するための準備手順を説明します。
環境情報
| サービス | 現在の環境URL |
|---|---|
| 管理画面 | https://zero-admin-review.vericerts.io |
| API | https://zero-engine-review.vericerts.io |
全体フロー
外部システムからVeriCerts Zero APIを利用するには、以下の4つのPartで準備を行います。
Part 1: VeriCerts初期準備(組織オーナー)
アカウント作成 → 組織登録 → VC作成
↓
Part 2: 外部システム用メンバーの招待(組織オーナー)
メンバー招待 → 発行権限設定
↓
Part 3: アカウント設定(招待されたメンバー)
招待の受諾 → API Credential発行
↓
Part 4: 外部システムからの連携(API)
OAuth Token取得 → API利用開始Part 1: VeriCerts初期準備
担当: 組織オーナー 操作場所: 管理画面
1.1 アカウント作成
- 管理画面のログインページ(
https://zero-admin-review.vericerts.io/ja/login)にアクセス - 画面下部の「アカウント作成」をクリック
- 以下の情報を入力
- 姓
- 名
- メールアドレス
- パスワード(8文字以上、大文字・小文字・数字を含む)
- 利用規約およびプライバシーポリシーに同意
- 登録完了(自動的にログインされ、ダッシュボードに遷移します)
注意: 次回以降のログインは、ログインページからメールアドレスとパスワードでログインできます。
1.2 組織登録
- アカウントを新規作成すると、自動的にダッシュボードに遷移し、組織作成・加入を促すオンボーディング画面が表示されます
- 「新しい組織を作成する」ボタンをクリック
- 組織情報を入力
- 基本情報(組織名・メールアドレス・電話番号・Webサイト情報など)
- 所在地情報
- 組織カテゴリ・業界
- サービスレベル・利用目的
- 「申請する」ボタンをクリック
- 組織の作成が株式会社VeriCertsに申請され、「申請が完了しました!」画面が表示されます
- 一旦ログアウトし、審査完了をお待ちください
- 右上のプロフィールボタン(アカウント名が表示されている部分)をクリック
- メニューから「ログアウト」をクリック
注意: 審査中の組織では、メンバー管理・DID管理・VC管理等の機能はご利用になれません。審査が完了すると、これらの機能が利用可能となります。
1.3 VC(VCスキーマ)の作成
なぜVC(VCスキーマ)作成が必要か
外部システムからAPIでVCを発行するには、あらかじめVCの構造(どのような項目を含むか)を定義しておく必要があります。 この定義が「VC(VCスキーマ)」です。例えば、資格証明VCであれば「氏名」「資格名」「取得日」などの項目を定義します。
API経由でVC発行を行う際は、このVCのIDを指定して発行リクエストを送信します。
作成手順
前提条件: 組織の審査が完了し、「有効」状態になっていること
- 管理画面のログインページ(
https://zero-admin-review.vericerts.io/ja/login)にアクセスし、ログインします - ログインすると、ダッシュボードが表示されます
- サイドメニューの「VC管理」をクリックして展開します
- 子メニューの「VCスキーマ作成」をクリックします
- 作成方法を選択
- テンプレートから作成(推奨): システムテンプレートをベースに作成
- 1から作成: 完全にオリジナルのスキーマを作成
- VCの構造を定義(名前、説明、項目の定義)
- 保存オプションを選択
- 下書きを保存: 下書き状態で保存
- 保存してステータス変更: 直接ステータスを設定
本ガイドでは: 外部システムからAPIでVC発行を行うため、最終的に「組織内運用」ステータスで公開する必要があります。下書きで保存した場合も、後からステータスを変更してください。
ステータス一覧(参考):
| ステータス | 用途 |
|---|---|
| 下書き | 下書きステータスのVCのみ編集が可能です |
| 組織内運用 | 組織内メンバーおよびエンティティDIDへのVC発行が可能 |
| 申請受付中 | VeriCertsアプリ上で一般ユーザーからのVC発行申請を受付けます |
| アーカイブ | 利用停止中のVC |
ステータス変更: VC一覧のステータス列をクリック → ダイアログで変更
注意:
- 一度「組織内運用」「申請受付中」「アーカイブ」のステータスにした場合、「下書き」には戻せません(編集不可)
- 「申請受付中」にした場合、組織情報・VC情報がVeriCertsアプリ上で公開され、一般ユーザーからのVC発行申請の受付を開始します。一般ユーザーへの発行を行わず、組織内でのみ利用する場合には「組織内運用」ステータスをご利用ください
Part 2: 外部システム用メンバーの招待
担当: 組織オーナー 操作場所: 管理画面
2.1 メンバー招待
前提条件: 組織の審査が完了し、「有効」状態になっていること
- 管理画面のログインページ(
https://zero-admin-review.vericerts.io/ja/login)にアクセスし、ログインします - サイドメニューの「メンバー管理」をクリックして展開
- 子メニューの「メンバー招待」をクリック
- 招待するメールアドレスを入力
- 複数のメールアドレスを招待する場合は「メールアドレスを追加」をクリック
- 「招待を送信」をクリック
- 招待結果ダイアログを確認し、必要に応じて再招待等を行います
注意:
- 招待メールには有効期限があります。期限切れの場合は再招待が必要です
- 招待結果は招待メールの送信成功を示すものであり、相手への到達を保証するものではありません。メールがブロックされている場合等もありますので、届かない場合は受信側の設定も合わせてご確認ください
2.2 発行権限設定
なぜ発行権限設定が必要か
VCは、オーナー(組織を作成したアカウント)のみ発行が可能となっており、招待したメンバーがAPI経由でVCを発行する場合は、VCごとに発行権限を明示的に付与する必要があります。
設定手順
- 管理画面のログインページ(
https://zero-admin-review.vericerts.io/ja/login)にアクセスし、ログインします - サイドメニューの「VC管理」→「VC一覧」をクリック
- 対象VCの操作列にある「権限設定」ボタン(ユーザーアイコン)をクリック
- 「発行権限設定」ダイアログが表示されます
- 発行権限を付与するメンバーにチェックを入れる
- 「保存」をクリック
注意: 「アーカイブ」ステータスのVCでは権限設定ボタンは表示されません
Part 3: アカウント設定
担当: 招待されたメンバー 操作場所: 管理画面
3.1 招待の受諾
- 招待メールを確認
- メール内のリンクをクリック
- 「参加する」をクリックすると、ログインまたは新規登録画面に遷移します
- ガイドに従ってログインまたはアカウント作成を行います
- 招待が完了して組織に参加すると、ダッシュボードが表示されます
→ 詳細ガイド: 招待の確認・組織への参加 | ログイン | アカウント作成
3.2 API Credential発行
- 管理画面のログインページ(
https://zero-admin-review.vericerts.io/ja/login)にアクセスし、ログインします - 右上のアカウントメニューから「プロフィール」を選択
- 「API Credential」セクションを開く
- 「新規発行」をクリック
- Credential名を入力(例: ●●システム連携用)
- 発行完了
発行される情報:
| 項目 | 説明 |
|---|---|
| Client ID | cli_xxxxxxxxxxxxx 形式 |
| Client Secret | 64文字の英数字 |
発行された情報をコピーし、連携する外部システムに設定してください。
⚠️ 重要: Client Secretは発行時のみ表示されます。必ず安全な場所に保存してください。紛失した場合は再発行が必要です。
→ 詳細ガイド: API Credential発行
Part 4: 外部システムからの連携
担当: 外部システム開発者 操作場所: 外部システム / API
4.1 Credentialの登録(外部システム側)
発行したCredentialを外部システムに登録します。
VERICERTS_CLIENT_ID=cli_xxxxxxxxxxxxx
VERICERTS_CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
VERICERTS_API_URL=https://zero-engine-review.vericerts.io
4.2 OAuth Token取得
エンドポイント: https://zero-engine-review.vericerts.io/v1/auth/token
curl -X POST "${VERICERTS_API_URL}/v1/auth/token" \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "cli_xxxxxxxxxxxxx",
"client_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'レスポンス:
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}| フィールド | 説明 |
|---|---|
| access_token | APIリクエストで使用するトークン |
| token_type | Bearer 固定 |
| expires_in | 有効期限(秒)。デフォルト3600秒(1時間) |
4.3 APIの利用
取得したトークンを Authorization ヘッダーに設定してAPIを呼び出します。
curl -X GET "${VERICERTS_API_URL}/v1/..." \
-H "Authorization: Bearer {access_token}"トークン更新: 有効期限(1時間)が切れた場合は、再度Token取得を行ってください。
次のステップ
準備が完了したら、実際のVC発行を試してみましょう。
- 著作権証明VCチュートリアル - 外部システムからVCを発行する実践的なチュートリアル
- APIリファレンス - API仕様の詳細