advertiser-api (0.0.1-dev)

Download OpenAPI specification:Download

広告主向けAPI

[POST]/v1/registration/issue

メールアドレスとパスワードを受け取り、仮登録用メールを送信する

Request Body schema: application/json
email
required
string

メールアドレス

password
required
string

平文パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "cookie_value": "string",
  • "expires": 0
}

[POST]/v1/registration/authentication

ユーザーが踏んだ仮登録用リンクが正しいか検証する

Request Body schema: application/json
auth_key
required
string

仮登録キー

cookie_value
required
string

ブラウザにセットした検証用Cookie値

Responses

Request samples

Content type
application/json
{
  • "auth_key": "string",
  • "cookie_value": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "expired_at": 0
}

[POST]/v1/login

ユーザーログイン

Request Body schema: application/json
email
required
string

メールアドレス

password
required
string

平文パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
null

[POST]/v1/login_2factor

ユーザーの二段階認証

Request Body schema: application/json
auth_key
required
string

仮登録キー

cookie_value
required
string

ブラウザにセットした検証用Cookie値

Responses

Request samples

Content type
application/json
{
  • "auth_key": "string",
  • "cookie_value": "string"
}

Response samples

Content type
application/json
null

[GET]/v1/user/profile

ユーザー情報の取得

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
null

[POST]/v1/user/profile

ユーザー情報の更新。初回更新時のみnullを許容しない。

Authorizations:
Bearer
Request Body schema: application/json
organization_name
any

会社名

organization_type
any

会社種別・個人事業主等nado

organization_postal_code
string^\d{7}$

会社住所_郵便番号

organization_prefecture_code
string^\d{2}$

会社住所_都道府県JISコード

organization_address_city
any

会社住所_住所欄1(郵便番号連動部分)

organization_address_detail
any

会社住所_住所欄2(上記以降の詳細部分)

user_family_name
any

代表者名_名字

user_given_name
any

代表者名_名前

user_family_name_ruby
string^[\u3040-\u309F]+$

代表者名_名字カナ

user_given_name_ruby
string^[\u3040-\u309F]+$

代表者名_名前カナ

user_postal_code
string^\d{7}$

代表者住所_郵便番号

user_prefecture_code
string^\d{2}$

代表者住所_都道府県JISコード

user_address_city
any

代表者住所_住所欄1(郵便番号連動部分)

user_address_detail
any

代表者住所_住所欄2(上記以降の詳細部分)

user_birthday
string^\d{4}-\d{2}-\d{2}$

代表者_生年月日

user_sex
any
Enum: "male" "female" "other"

代表者_性別

user_yearly_income
string^\d{1,}$

代表者_年収

Responses

Request samples

Content type
application/json
{
  • "organization_name": null,
  • "organization_type": null,
  • "organization_postal_code": "string",
  • "organization_prefecture_code": "string",
  • "organization_address_city": null,
  • "organization_address_detail": null,
  • "user_family_name": null,
  • "user_given_name": null,
  • "user_family_name_ruby": "string",
  • "user_given_name_ruby": "string",
  • "user_postal_code": "string",
  • "user_prefecture_code": "string",
  • "user_address_city": null,
  • "user_address_detail": null,
  • "user_birthday": "string",
  • "user_sex": "male",
  • "user_yearly_income": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

[POST]/v1/user/assets

ユーザーの証明画像を受け取り保存する

Authorizations:
Bearer
Request Body schema: multipart/form-data
asset_type
required
string
files
required
Array of strings <binary>

[GET]/v1/user/status

ユーザーステータス

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
null

[GET]/v1/user/ad_spaces

広告枠を取得

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
null

[POST]/v1/ad_spaces

広告購入をリクエスト。購入可能か判定

Authorizations:
Bearer
Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "message": "string"
}

[POST]/v1/ad_spaces/payment

広告購入トランザクション(wip)

[POST]/v1/token/refresh

トークンのリフレッシュ

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

[DELETE]/v1/logout

ログアウト

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}