Nico API は以下の機能を持ちます。

保険契約申込操作を行うAPIをコールする際には事前に代理店認証を行い、代理店トークンの発行を行う必要があります。

認証方式の種類

OAuth2.0（ RFC 6749 ）で定義されている、2種類のグラントに対応した認可・認証サービスを提供します。

• 認可コードグラント
• クライアントクレデンシャルグラント

※ 定義参照) RFC 6749: The OAuth 2.0 Authorization Framework

認可コードグラントで発行されるトークンも、クライアントクレデンシャルグラントも、リソースサーバ側では同じフォーマットのトークンとして検証され、トークン内部に記載されている scope 等により認可範囲が確認されます。

認証方式の種類の使い分け

認証方式により認可されるAPIの種類(scope)が異なります。
賃貸契約管理プラットフォームからの契約申込のように代理店ユーザからの要求に応じてコールを行うことが想定される場合は認可コードグラント、契約状況照会APIのようにバッチ処理等の自動処理でAPI要求を行うことがある場合はクライアントクレデンシャルグラントで取得する代理店トークンに認可を付与しています。

家賃保証会社の保有する保証契約管理システムで家賃保証申込が承認された際に契約申込をする場合など、代理店ユーザの要求がない情報連携に際してはクライアントクレデンシャルグラントで取得する代理店トークンにも契約申込の認可を付与する場合があります。 詳細は当社営業担当にお問い合わせ下さい。

認可コードグラントで取得した代理店トークンは3日間、クライアントクレデンシャルグラントで取得した代理店トークンは1日の有効期限があります。

Nico API利用申込

当社営業担当に利用開始希望のご連絡をお願いします。
認可コードグラントをご利用される場合、事前に callback_uri を登録させていただきます。 クライアントクレデンシャルグラントを利用される場合、当社がご利用頂く代理店ごとに発行する client_id, client_secret の文字列を貴社システムに保持頂く必要があります。

認証方法に関わらずご提供する情報

認可コードグラント、クライアントクレデンシャルグラントを利用する場合のいずれも、プラットフォームIDをご連携いたします。 契約申込 API をリクエストする際、ご指定が必要となります。

認可コードグラント利用に必要な callback_uri 情報

認可コード要求リクエスト時、代理店ユーザを当社ログイン画面から貴社システムに画面遷移させるための redirect_uri(ログイン成功時の遷移先)、cancel_uri(戻るボタン押下時の遷移先) を指定いただきます。 redirect_uri と cancel_uri は事前登録頂く callback_uri と以下の方法で入力チェックを行いますので連携前にご用意が必要となります。

■ redirect_uri は callback_uri と前方一致で確認いたします。

例 )
callback_uri: https://www.n-ssi.co.jp/callback の場合

O redirect_uri: https://www.n-ssi.co.jp/callback?hoge=fuga
O redirect_uri: https://www.n-ssi.co.jp/callback
X redirect_uri: https://example.n-ssi.co.jp/callback

■ cancel_uri は callback_uri とホスト名一致で確認いたします。

例 )
callback_uri: https://www.n-ssi.co.jp/callback の場合

O cancel_uri: https://www.n-ssi.co.jp/callback?val=cancel
O cancel_uri: https://www.n-ssi.co.jp/cancel
O cancel_uri: https://www.n-ssi.co.jp/cancel?hoge=fuga
X cancel_uri: https://example.n-ssi.co.jp/callback

クライアントクレデンシャルグラント利用に必要な client_id, client_secret 情報

所定の情報連携方法にて代理店利用開始/終了の管理をさせていただきます。 利用開始前に当社が代理店ごとの client_id, client_secret を発行し、ご連携いたします。 代理店トークン取得時に利用できるよう、貴社システムにご登録をお願い致します。

利用登録後当社からお送りするパラメータ

認証

代理店トークンの指定は Authorization: Bearer {{代理店トークン}} で指定してください。
例) CURLでの指定例
curl -H 'Authorization: Bearer {{代理店トークン}}'

文字コード

本APIで利用する文字コードはUTF-8となります。
ただし契約申込APIで利用できる文字はSJISに変換可能な文字コードとなります。

文字数

本API仕様書に記載の最大文字数はSJIS換算でのバイト表記となります。
半角文字は1、全角文字は2としてカウントします。

日付パラメータの指定

日付を示すパラメータはYYYY/MM/DD(0埋めスラッシュ区切り)で指定してください。
例) 2023年12月1日 → 2023/12/01

郵便番号と電話番号

郵便番号と電話番号は数字のみで指定してください
例)
O 5300011
X 530-0011

O 09011112222
X 090-1111-2222

代理店認証