文責：21YunBox China エンジニアリングチーム · 公開 2020年7月2日

これらのウェブサービスを使って、中国向けのSMSベースのログインシステムを構築できます。

API ベースURL

ベースURLは担当のアカウントマネージャーから割り当てられます。以下のエンドポイントと組み合わせて、認証（Auth）サービスにアクセスしてください。

エンドポイント：POST /get-code

このAPIを使って、ユーザーの電話にSMS認証コードを送信します。

リクエスト：

  • HTTPメソッド： POST
  • 形式： JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>"
}

レスポンス（成功時）

{
    "status": "ok",
    "phone_no": "<PHONE_NO>"
}

レスポンス（失敗時）

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

フィールド

  • key：担当のアカウントマネージャーから発行される、貴社のAPIキーです。
  • phone_no：認証コードの送信先となる、ユーザーの電話番号です。
  • status：リクエストが成功すると ok を返します。
  • code：リクエストが失敗した際に返されるエラーコードです。詳細はエラーコードのセクションを参照してください。
  • msg：リクエストが失敗した際に返される短いメッセージです。詳細はエラーコードのセクションを参照してください。

エラーコードと定義

  • 0070：リクエストの形式がJSONではありません。
  • 0072：JSON内の引数 phone_no または key が不足しています。
  • 0073：キーが無効です。APIキーの取得については、担当のアカウントマネージャーにお問い合わせください。
  • 0075：電話番号が無効です。
  • 0077：テスト用電話番号です。

エンドポイント：POST /check-code

有効なSMS認証コードが入力された際に、このAPIを使ってログインまたは新規ユーザー登録を行います。

リクエスト

  • HTTPメソッド： POST
  • 形式： JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>",
    "user_input_code": "..."
}

レスポンス（成功時）

{
  "status": "ok",
  "yb_uid": "<>"
}

レスポンス（失敗時）

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

フィールド

  • key：担当のアカウントマネージャーから発行される、貴社のAPIキーです。
  • phone_no：認証コードの送信先となる、ユーザーの電話番号です。
  • user_input_code：ユーザーが入力したコードです。
  • status：リクエストが成功すると ok を返します。
  • yb_uid：ユーザーの登録またはログインに成功した際に返されます。このUIDをアプリに渡すと、暗号化接続を有効化できます。
  • code：リクエストが失敗した際に返されるエラーコードです。詳細はエラーコードのセクションを参照してください。
  • msg：リクエストが失敗した際に返される短いメッセージです。詳細はエラーコードのセクションを参照してください。

エラーコードと定義

  • 0070：リクエストの形式がJSONではありません。
  • 0072：JSON内の引数 phone_no または key が不足しています。
  • 0073：キーが無効です。APIキーの取得については、担当のアカウントマネージャーにお問い合わせください。
  • 0075：電話番号が無効です。
  • 0076：SMS認証コードの形式が無効です。
  • 0077：コードが無効か、有効期限が切れています。
  • 0078：システムエラー。暗号化接続の構成の作成に失敗しました。
  • 0079：システムエラー。暗号化接続の構成の作成に失敗しました。
  • 0100：アカウントの残高が不足しています。
  • -1：予期しないシステムエラーです。

テスト用の電話番号とコード

この電話番号とSMS認証コードを使うと、テスト目的に限り認証プロセスをスキップできます。

{
    "key": "<API_KEY>",
    "phone_no": "12345678910",
    "user_input_code": "4433"
}

エンドポイント：POST /u/<yb_uid>/devices

このAPIを使って、ユーザーの新しいデバイスを作成します。

リクエスト

  • HTTPメソッド： POST
  • 形式： JSON
{
    "key": "<API_KEY>"
}

レスポンス（成功時）

{
  "status": "ok",
  "device_id": "<DEVICE_ID>"
}

レスポンス（失敗時）

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

フィールド

  • key：担当のアカウントマネージャーから発行される、貴社のAPIキーです。
  • status：リクエストが成功すると ok を返します。
  • device_id：新しいデバイスの作成に成功した際に返されます。このIDをアプリに渡すと、暗号化接続を有効化できます。
  • code：リクエストが失敗した際に返されるエラーコードです。詳細はエラーコードのセクションを参照してください。
  • msg：リクエストが失敗した際に返される短いメッセージです。詳細はエラーコードのセクションを参照してください。

エラーコードと定義

  • 0070：リクエストの形式がJSONではありません。
  • 0071：JSON内の引数 key が不足しています。
  • 0073：キーが無効です。APIキーの取得については、担当のアカウントマネージャーにお問い合わせください。
  • 0078：システムエラー。暗号化接続の構成の作成に失敗しました。
  • 0079：システムエラー。暗号化接続の構成の作成に失敗しました。
  • 0200：UIDが無効です。
  • 0202：ユーザーが存在しません。
  • -1：予期しないシステムエラーです。

エンドポイント：GET /u/<yb_uid>/devices

このAPIを使って、ユーザーが保有するデバイスの一覧を取得します。

リクエスト

  • HTTPメソッド： GET

レスポンス（成功時）

{
  "status": "ok",
  "device_ids": [
      "<DEVICE_ID_1>",
      "<DEVICE_ID_2>",
      ...
  ]
}

レスポンス（失敗時）

{
    "code": "<ERROR_CODE>",
    "msg": "<MESSAGE>"
}

フィールド

  • status：リクエストが成功すると ok を返します。
  • device_ids：ユーザーが保有するデバイスの一覧を返します。ここには、直近で作成された10件のデバイスのみが表示されます。
  • code：リクエストが失敗した際に返されるエラーコードです。詳細はエラーコードのセクションを参照してください。
  • msg：リクエストが失敗した際に返される短いメッセージです。詳細はエラーコードのセクションを参照してください。

エラーコードと定義

  • 0200：UIDが無効です。
  • 0202：ユーザーが存在しません。
  • -1：予期しないシステムエラーです。

21YunBox を試しませんか？

導入のご相談