クイックスタート

SMSメールVoice

※この下の手順は概要です。詳細なAPI仕様やパラメータについては関連APIをご参照ください。

1. アプリケーションを作成する

POST /2fa/2/applications
Content-Type: application/json
Authorization: App {API_KEY}

{
    "name": "2FAサンプル",
    "pinAttempts": 5,
    "pinTimeToLive": "300s"
}

applicationIdが発行されます。

2. メッセージテンプレートを作成する

POST /2fa/2/applications/{appId}/messages
Content-Type: application/json
Authorization: App {API_KEY}

{
    "pinType": "NUMERIC",
    "messageText": "認証コードは {{pin}} です。",
    "pinLength": 4,
    "senderId": "NTTCPAAS"
}

messageIdが発行されます。

3. OTPを送信する

POST /2fa/2/pin
Content-Type: application/json
Authorization: App {API_KEY}

{
    "applicationId": "YOUR_APPLICATION_ID",
    "messageId": "YOUR_MESSAGE_ID",
    "from": "NTT CPaaS 2FA",
    "to": "819012345678"
}

レスポンスでpinIdが返ります。

4. OTPを検証する

POST /2fa/2/pin/{pinId}/verify
Content-Type: application/json
Authorization: App {API_KEY}

{
    "pin": "1234"
}

検証結果が返ります。

※この下の手順は概要です。詳細なAPI仕様やパラメータについては関連APIをご参照ください。

1. アプリケーションを作成する

POST /2fa/2/applications
Content-Type: application/json
Authorization: App {API_KEY}

{
    "name": "2FAサンプル",
    "pinAttempts": 5,
    "pinTimeToLive": "300s"
}

applicationIdが発行されます。

2. メッセージテンプレートを作成する - 事前にNTT CPaaSポータルページでブロードキャストテンプレートを作成し、その番号（emailTemplateId）を控えておきます。

POST /2fa/2/applications/{appId}/email/messages
Content-Type: application/json
Authorization: App {API_KEY}

{
    "pinType": "NUMERIC",
    "pinLength": 4,
    "emailTemplateId": 350140
}

messageIdが発行されます。

3. OTPを送信する

POST /2fa/2/pin/email
Content-Type: application/json
Authorization: App {API_KEY}

{
    "applicationId": "YOUR_APPLICATION_ID",
    "messageId": "YOUR_MESSAGE_ID",
    "to": "user@example.com"
}

レスポンスでpinIdが返ります。

4. OTPを検証する

POST /2fa/2/pin/{pinId}/verify
Content-Type: application/json
Authorization: App {API_KEY}

{
    "pin": "1234"
}

検証結果が返ります。

※この下の手順は概要です。詳細なAPI仕様やパラメータについては関連APIをご参照ください。

1. アプリケーションを作成する

POST /2fa/2/applications
Content-Type: application/json
Authorization: App {API_KEY}

{
    "name": "2FAサンプル",
    "pinAttempts": 5,
    "pinTimeToLive": "300s"
}

applicationIdが発行されます。

2. メッセージテンプレートを作成する

POST /2fa/2/applications/{appId}/messages
Content-Type: application/json
Authorization: App {API_KEY}

{
    "pinType": "NUMERIC",
    "messageText": "認証コードは {{pin}} です。",
    "pinLength": 4,
    "senderId": "NTTCPAAS"
}

messageIdが発行されます。

3. OTPを送信する

POST /2fa/2/pin/voice
Content-Type: application/json
Authorization: App {API_KEY}

{
    "applicationId": "YOUR_APPLICATION_ID",
    "messageId": "YOUR_MESSAGE_ID",
    "to": "819012345678"
}

レスポンスでpinIdが返ります。

4. OTPを検証する

POST /2fa/2/pin/{pinId}/verify
Content-Type: application/json
Authorization: App {API_KEY}

{
    "pin": "1234"
}

検証結果が返ります。

次に進む