Documentation Powered by ReDoc

JPKI認証対応API (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

本APIでは、docomo business RINKのドキュメントリソース情報の参照・操作が可能です。

document

JPKIリクエスト発行API

JPKIリクエストを発行、返却するAPI

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

正常

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

post/v1/jpki/jpki-requests
https://api.ntt.com/sdpf-ztgict/v1/jpki/jpki-requests

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

認証終了判定API

スマホ側で本人確認が完了したかのステータスをチェックするAPI

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

正常

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

502

Bad Gateway

503

Service Unavailable

get/v1/jpki/jpki-requests/{jpkiRequestId}
https://api.ntt.com/sdpf-ztgict/v1/jpki/jpki-requests/{jpkiRequestId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "completed",
  • "errorCode": "00",
  • "errorMessage": "正常"
}