staging
 Back to top

申込受付くんWebAPIドキュメント

WebAPI利用までの流れ

  1. 弊社が保証会社様のアカウントを発行いたします。

  2. 保証会社様のEメールアドレス宛に保証会社管理メニューへのURLを添付して送ります。

  3. 保証会社管理メニューにログイン後、以下の設定をお願いいたします。

    • アカウント設定
    • APIキーの確認
    • 許可IPアドレス設定

共通HTTPヘッダ

共通HTTPヘッダは2種類あります

  1. Authorization
  2. X-API-VERSION

APIはAuthorizationヘッダで認証します。

API-VERSIONが設定されない場合最新バージョンのAPIが呼び出されます。

例:APIキーが xxxxxxxxx でAPI-VERSIONが 1 の場合以下のようになります。

Authorization: Token xxxxxxxxx
X-API-VERSION: 1

各種仕様書

下記より、ファイルのダウンロード、またはページへの遷移を行ってください。


WebAPI

型定義

  • numberはinteger(11桁)

  • stringはtext(65,535bytes)

区分

entry_status_id Name
10 審査項目入力中
15 保証会社変更による再入力中
20 審査開始待ち
30 管理会社審査
40 保証会社審査
50 決済会社審査
60 オーナー審査
110 契約前
101 契約準備中
105 契約書発送
120 契約
200 管理会社キャンセル
201 申込者キャンセル
202 システムキャンセル
203 他申込で契約済みキャンセル
type Name
address 住所フォーム
birthday 誕生日フォーム
check_box チェックボックスフォーム
radio ラジオボタンフォーム
date 日付フォーム
number 数値フォーム
float_number 小数あり数値フォーム
fullname フルネームフォーム
text テキストフォーム
text_kana テキストカナフォーム
phone_number 電話番号フォーム
image 画像フォーム
year_month 年月フォーム

区分詳細

申込内容 api-version 1

申込一覧

申込一覧の取得
GET/guarantees/api/entry_heads{?datetime,end_datetime}

保証会社審査ステータスになっている申込一覧の取得

Example URI

GET https://moushikomi-uketsukekun.com/guarantees/api/entry_heads?datetime=2018-01-01T20:00:00&end_datetime=2018-01-01T20:00:00
URI Parameters
HideShow
datetime
string (optional) Example: 2018-01-01T20:00:00

指定した日時以降に更新があった申込情報を返します。
指定しない場合は呼び出し日になります 例: 2018-01-01T00:00:00

end_datetime
string (optional) Example: 2018-01-01T20:00:00

指定された日時までの間に更新があった申込情報を返します。
指定しない場合はdatetimeに指定されている日時以降の申込情報を返します 例: 2018-01-01T00:00:00

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1234,
    "company_master_id": 1,
    "room_id": 1234,
    "entry_status_id": 30,
    "guarantee_plan_id": 1234,
    "paper": false,
    "created_at": "2018-01-25T14:54:47.000+09:00",
    "updated_at": "2018-01-25T14:54:47.000+09:00",
    "entry_user": {
      "first_name": "太郎",
      "last_name": "イタンジ",
      "full_name": "イタンジ 太郎"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }

申込一覧

申込一覧の取得(申込内容の更新があったものを含む)
GET/guarantees/api/entry_heads/updated{?datetime,end_datetime}

保証会社審査ステータスになっている申込一覧の取得

Example URI

GET https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/updated?datetime=2018-01-01T20:00:00&end_datetime=2018-01-01T20:00:00
URI Parameters
HideShow
datetime
string (optional) Example: 2018-01-01T20:00:00

指定した日時以降に申込内容に更新があった申込情報を返します。
指定しない場合は呼び出し日になります 例: 2018-01-01T00:00:00

end_datetime
string (optional) Example: 2018-01-01T20:00:00

指定された日時までの間に更新があった申込情報を返します。
指定しない場合はdatetimeに指定されている日時以降の申込情報を返します 例: 2018-01-01T00:00:00

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1234,
    "company_master_id": 1,
    "room_id": 1234,
    "entry_status_id": 30,
    "guarantee_plan_id": 1234,
    "paper": false,
    "created_at": "2018-01-25T14:54:47.000+09:00",
    "updated_at": "2018-01-25T14:54:47.000+09:00",
    "entry_user": {
      "first_name": "太郎",
      "last_name": "イタンジ",
      "full_name": "イタンジ 太郎"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }

申込詳細

申込内容の取得
GET/guarantees/api/entry_heads/{id}

申込内容の取得

ご注意

申込内容(Body)は保証会社様によってフォーマットが異なりますので別途こちらから確認をお願いいたします。

Example URI

GET https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/1234
URI Parameters
HideShow
id
number (required) Example: 1234

申込ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "entry_head": {
    "id": 1234,
    "company_master_id": 1,
    "room_id": 1234,
    "entry_status_id": 30,
    "guarantee_plan_id": 1234,
    "paper": false,
    "created_at": "2018-01-25T14:54:47.000+09:00",
    "updated_at": "2018-01-25T14:54:47.000+09:00",
    "entry_user": {
      "first_name": "太郎",
      "last_name": "イタンジ",
      "full_name": "イタンジ 太郎"
    }
  },
  "entry_bodies": [
    {
      "id": 1,
      "type": "full_name",
      "first_name": "太郎",
      "last_name": "イタンジ",
      "full_name": "イタンジ 太郎",
      "first_name_kana": "タロウ",
      "last_name_kana": "イタンジ",
      "name": "name_kana"
    },
    {
      "id": 2,
      "type": "radio",
      "choice": "男",
      "other": "null",
      "choice_id": 1,
      "name": "sex"
    },
    {
      "id": 3,
      "type": "checkbox",
      "choice": [
        "ペット",
        "駐輪場"
      ],
      "other": "null",
      "choice_id": [
        "30",
        "40"
      ],
      "name": "options"
    },
    {
      "id": 4,
      "type": "radio",
      "choice": "その他",
      "other": "個人事業主",
      "choice_id": 10,
      "name": "job"
    },
    {
      "id": 5,
      "type": "birthday",
      "birthday": "1992-02-22 00:00:00",
      "name": "birthday"
    },
    {
      "id": 6,
      "type": "text",
      "text": "イタンジ株式会社",
      "name": "workplace"
    },
    {
      "id": 7,
      "type": "text_kana",
      "text_kana": "イタンジカブシキガイシャ",
      "name": "workplace_kana"
    },
    {
      "id": 8,
      "type": "phone_number",
      "phone_number": "000-0000-0000",
      "name": "workplace_tel"
    },
    {
      "id": 9,
      "type": "number",
      "number": 90000,
      "name": "rent"
    },
    {
      "id": 10,
      "type": "float_number",
      "float_number": 30.8,
      "name": "monthly_income"
    },
    {
      "id": 11,
      "type": "date",
      "date": "2018-02-22",
      "name": "move_in_date"
    },
    {
      "id": 12,
      "type": "image",
      "image": "http://example.com/images/1",
      "name": "passport"
    },
    {
      "id": 13,
      "type": "address",
      "zip_code": "1350063",
      "state": "東京都",
      "city": "江東区豊洲",
      "street": "4丁目9−13",
      "other": "東京フロントコート",
      "name": "address"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "entry_head": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "申込ID"
        },
        "company_master_id": {
          "type": "number",
          "description": "管理会社ID"
        },
        "room_id": {
          "type": "number",
          "description": "部屋ID"
        },
        "entry_status_id": {
          "type": "number",
          "enum": [
            30
          ],
          "description": "申込ステータスID"
        },
        "guarantee_plan_id": {
          "type": "number",
          "description": "保証会社プランID"
        },
        "paper": {
          "type": "boolean",
          "description": "紙での申込みかフラグ、 true: 紙での申込み, false: WEBからの申込み"
        },
        "created_at": {
          "type": "string",
          "description": "作成日"
        },
        "updated_at": {
          "type": "string",
          "description": "更新日"
        },
        "entry_user": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "full_name": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "id",
        "company_master_id",
        "room_id",
        "entry_status_id",
        "guarantee_plan_id",
        "paper",
        "created_at",
        "updated_at"
      ]
    },
    "entry_bodies": {
      "type": "array"
    }
  },
  "required": [
    "entry_head"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }
Response  403
HideShow
Body
戻り値はありません。
Response  404
HideShow
Body
戻り値はありません。

申込審査

審査結果取込
PUT/guarantees/api/entry_heads/{id}/judge

審査結果を取り込んで申込のステータスを更新します

Example URI

PUT https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/1234/judge
URI Parameters
HideShow
id
number (required) Example: 1234

申込ID

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "ok": false, # true: 審査通過 false: 審査落ち
    "result_surety_number": "A12345678" # 保証番号
    "result_monthly_fee": 100000 # 保証対象額
    "result_guarantee_charge": 80000 # 初回保証料
    "remarks": "返済比率が25%以上のため審査NGです" # 管理会社への連絡事項
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }
Response  403
HideShow
Body
戻り値はありません。
Response  404
HideShow
Body
戻り値はありません。
Response  422
HideShow
Body
戻り値はありません。

申込審査

審査保留取込
PUT/guarantees/api/entry_heads/{id}/pending

審査結果を取り込んで申込のステータスを保留に更新します

Example URI

PUT https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/1234/pending
URI Parameters
HideShow
id
number (required) Example: 1234

申込ID

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "remarks": "返済比率が25%以上のため審査保留中です" # 管理会社への連絡事項
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }
Response  403
HideShow
Body
戻り値はありません。
Response  404
HideShow
Body
戻り値はありません。
Response  422
HideShow
Body
戻り値はありません。

申込審査

審査開始取込
PUT/guarantees/api/entry_heads/{id}/judge_start

審査開始ステータスを取り込みます。

Example URI

PUT https://moushikomi-uketsukekun.com/guarantees/api/entry_heads/1234/judge_start
URI Parameters
HideShow
id
number (required) Example: 1234

申込ID

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "remarks": "審査を開始します。内容変更があればご連絡をお願いいたします" # 管理会社への連絡事項
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }
Response  403
HideShow
Body
戻り値はありません。
Response  404
HideShow
Body
戻り値はありません。
Response  422

キャンセル済み申込一覧

キャンセル済み申込一覧の取得
GET/guarantees/api/cancelled_entry_heads{?datetime}

申込キャンセルになった申込一覧の取得

  • 申込者キャンセル

  • 管理会社キャンセル

  • システムキャンセル

Parameters/Responseは 申込一覧の取得 と同様

Example URI

GET https://moushikomi-uketsukekun.com/guarantees/api/cancelled_entry_heads?datetime=2018-01-01T20:00:00
URI Parameters
HideShow
datetime
string (optional) Example: 2018-01-01T20:00:00

取得したい日時
指定しない場合は呼び出し日になります 例: 2018-01-01T00:00:00

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1234,
    "company_master_id": 1,
    "room_id": 1234,
    "entry_status_id": 30,
    "guarantee_plan_id": 1234,
    "created_at": "2018-01-25T14:54:47.000+09:00",
    "updated_at": "2018-01-25T14:54:47.000+09:00",
    "entry_user": {
      "first_name": "太郎",
      "last_name": "イタンジ",
      "full_name": "イタンジ 太郎"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{ message: 'token invalid' }

Generated by aglio on 30 Aug 2019