API docs by Redocly

docomo business SIGN アプレット APIリファレンス (1.0.0)

Download OpenAPI specification:

URL: https://sdpf.ntt.com License: NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

docomo business SIGN アプレット APIリファレンス

アプレット用API

アプレットを管理するAPI

アプレット契約

アプレット契約を行います。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
domain
required
string [ 2 .. 32 ] characters ^[a-z0-9-]+$

アプレットのドメイン
例: example と指定した場合は、アプレットコンソールURLは https://example.sign.ntt.com/ になります。

email
required
string <email> <= 254 characters ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-....

担当者のメールアドレス

Responses

Request samples

Content type
application/json
{
  • "domain": "example",
  • "email": "test@example.com"
}

Response samples

Content type
application/json
{
  • "domain": "example",
  • "email": "test@example.com",
  • "createdAt": "2024-06-10T06:30:30Z"
}

アプレット契約取得

アプレット契約情報を取得します。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "domain": "example",
  • "email": "test@example.com",
  • "createdAt": "2024-06-10T06:30:30Z"
}

アプレット契約解約

アプレット契約を解約します。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "errorCode": 10104,
  • "errorMessages": [
    ]
}