Documentation Powered by ReDoc

Value-Auth API (1.0)

Download OpenAPI specification:Download

概要

Value-Auth APIを使用することで、お客様のWebサービスに簡単に認証システムを導入することができます。

API認証キー

Value-Auth APIはBearer認証で保護されています。予めAPI認証キーを発行しAuthorizationヘッダーに付与してAPIを利用いたします。

API認証キーの発行はこちらから

Authorization: Bearer {api_key}

APIの利用

エンドポイント：https://api.valueauth.jp/v1/

HTTPプロトコルのGET,POST,PUT,DELETEメソッドでレスポンスを送信します。

本人確認

このAPIを利用することで、Webサービスに本人確認の仕組みを導入することができます。
利用するには事前にサイトの登録が必要になります。
サイトの登録はこちら

認証コードの確認方法は、「ユーザーガイド：使用するサイトの設定」の”認証の有効化と認証コードの確認”をご確認下さい
ユーザーガイド

本人確認の認証番号を送信

Authorizations:
path Parameters
auth_code
required
string

認証コード

query Parameters
send_kbn
required
integer

送信区分（1:SMS、2:メール）

address
required
string

送信先（携帯番号、メールアドレス）

Responses

Request samples 

curl -H 'Accept: application/json' \
      -H "Authorization: Bearer {api_key}"\
      https://api.valueauth.jp/v1/{auth_code}/auth?address=test@example.com\&send_kbn=2

Response samples

Content type
application/json
{
  • "results": {
    }
}

本人確認の認証番号を確認

Authorizations:
path Parameters
auth_code
required
string

認証コード

Request Body schema: application/json

認証情報

address
string (address)

送信先（携帯番号、メールアドレス）

number
string (number)

認証番号

Responses

Request samples

Content type
application/json
{
  • "address": "*****@*****.com",
  • "number": "123456"
}

Response samples

Content type
application/json
{
  • "results": "ok"
}

二段階認証

このAPIを利用することで、Webサービスに二段階認証の仕組みを導入することができます。
利用するには事前にサイトの登録が必要になります。
サイトの登録はこちら

認証コードの確認方法は、「ユーザーガイド：使用するサイトの設定」の”認証の有効化と認証コードの確認”をご確認下さい
ユーザーガイド

二段階認証のAPIを利用するには、事前に「二段階認証／利用者連絡先」APIで、利用者の連絡先を登録する必要があります。

二段階認証の認証番号を送信

Authorizations:
path Parameters
auth_code
required
string

認証コード

query Parameters
customer_key
required
string

利用者キー
※ ご利用されるWebサービスで一意となるユーザーID等を設定してください。

Responses

Request samples 

curl -H 'Accept: application/json' \
      -H "Authorization: Bearer {api_key}"\
      https://api.valueauth.jp/v1/{auth_code}/twofactor?customer_key=1234

Response samples

Content type
application/json
{
  • "results": {
    }
}

二段階認証の認証番号を確認

Authorizations:
path Parameters
auth_code
required
string

認証コード

Request Body schema: application/json

認証情報

customer_key
string (customer_key)

利用者キー
※ ご利用されるWebサービスで一意となるユーザーID等を設定してください。

number
string (number)

認証番号

Responses

Request samples

Content type
application/json
{
  • "customer_key": "1234",
  • "number": "123456"
}

Response samples

Content type
application/json
{
  • "results": "ok"
}

二段階認証／利用者連絡先

二段階認証で送られる認証番号の送信先を管理するAPIです。

登録済の利用者連絡先を取得

Authorizations:
path Parameters
auth_code
required
string

認証コード

query Parameters
customer_key
required
string

利用者キー
※ ご利用されるWebサービスで一意となるユーザーID等を設定してください。

Responses

Request samples 

curl -H 'Accept: application/json' \
      -H "Authorization: Bearer {api_key}"\
      https://api.valueauth.jp/v1/{auth_code}/twofactor/contact?customer_key=1234

Response samples

Content type
application/json
{
  • "results": {
    }
}

利用者連絡先を登録

Authorizations:
path Parameters
auth_code
required
string

認証コード

Request Body schema: application/json

利用者の連絡先

customer_key
string (customer_key)

利用者キー
※ ご利用されるWebサービスで一意となるユーザーID等を設定してください。

address
string (address)

送信先（携帯番号、メールアドレス）

send_kbn
integer (send_kbn)

送信区分（1:SMS、2:メール）

Responses

Request samples

Content type
application/json
{
  • "customer_key": "1234",
  • "address": "*****@*****.com",
  • "send_kbn": "2"
}

Response samples

Content type
application/json
{
  • "results": {
    }
}

登録済の利用者連絡先を変更

Authorizations:
path Parameters
auth_code
required
string

認証コード

contact_id
required
integer

利用者連絡先ID
※「登録済の利用者連絡先を取得」APIから確認できます

Request Body schema: application/json

利用者の連絡先

customer_key
string (customer_key)

利用者キー
※ ご利用されるWebサービスで一意となるユーザーID等を設定してください。

address
string (address)

送信先（携帯番号、メールアドレス）

send_kbn
integer (send_kbn)

送信区分（1:SMS、2:メール）

Responses

Request samples

Content type
application/json
{
  • "customer_key": "1234",
  • "address": "*****@*****.com",
  • "send_kbn": "2"
}

Response samples

Content type
application/json
{
  • "results": {
    }
}

登録済の利用者連絡先を削除

Authorizations:
path Parameters
auth_code
required
string

認証コード

contact_id
required
integer

利用者連絡先ID
※「登録済の利用者連絡先を取得」APIから確認できます

query Parameters
customer_key
required
string

利用者キー
※ ご利用されるWebサービスで一意となるユーザーID等を設定してください。

Responses

Request samples 

curl -X DELETE -H 'Accept: application/json' \
      -H "Authorization: Bearer {api_key}"\
      https://api.valueauth.jp/v1/{auth_code}/twofactor/contact/{contact_id}?customer_key=1234

Response samples

Content type
application/json
{
  • "results": {
    }
}