CSサイト-API仕様案

API一覧

エラーコード

ログインAPI

  • CSサイトから利用、メディカパスポートIDとパスワードを送信しMPの認証結果およびプロフィール情報を返す
JSONデータ仕様
◆URL
/api/login.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
login_id ログインID string 〇 メディカパスポートID
メールアドレスなのでバリデーションルールは一般的なメールアドレスのチェックのみです。
IVPの仕様書には明記されていませんが、弊社側で100文字までの制限をしています。
login_pw ログインID string 〇 パスワード
半角英数字（a-zA-Z0-9）の8〜16文字
login_type ログイン種別 string

FitNs. : clinic

BeNs. : basic

未指定 : clinic
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK：認証済、NG：未認証
error_code エラーコード string 一覧
passportid メディカパスポートID string
passportno メディカパスポートNo int
type 会員種別 int

0 : 一般会員

10 : 法人会員(生徒)

20 : 法人会員(教師・管理者)

30 : 法人会員(一般)
payed 課金種別 int

0 : 無料会員

1 : 有料会員(スタンダード)

2 : 有料会員(プレミアム)

※会員種別が10または20の場合は「1」で固定

※現在の機能の状態がレスポンスされます
※プレミアム会員からスタンダード会員への契約移行期間中は「2」
※プレミアム会員からの解約移行期間中は「2」
next_payed 次回課金種別 int

0 : 無料会員

1 : 有料会員(スタンダード)

2 : 有料会員(プレミアム)

※会員種別が10または20の場合は「1」で固定

※次回の契約更新後の状態がレスポンスされます
※現在有料会員の場合で解約中の場合は「0」
※プレミアム会員からスタンダードへの移行期間中は「1」
※プレミアム会員からの解約移行期間中は「0」
※有料会員（法人）の場合は、法人契約期間終了後の契約状態になります。

billing_type 契約期間タイプ int

0 : 月間契約（またはデフォルト）

10 : 年間契約
next_billing_type 次回契約期間タイプ int

0 : 月間契約（またはデフォルト）

10 : 年間契約
plan_lock_flag プラン固定フラグ int

（プレミアム→STDへ変更した場合は次回の契約更新までプラン変更不可）

0 : 変更可能

1 : 変更不可
coupon_status クーポン使用状況 int 契約時にどのクーポンを使用したか

※旧(coupon_c_flag)

0 : 未使用

1 : 個人クーポン使用

2 : 法人クーポン使用
coupon_expiration_at クーポン有効期限 datetime クーポン適用となる期限
next_payed_at 次回決済日 datetime 次回の課金日
next_distribution_at 次回配布日 datetime 次回のチケット配布日

※有料会員（個人）の場合、契約更新日とも一致
※有料会員（法人クーポン会員）の場合、契約更新日とは必ずしも一致しない
※次回チケット配布日が存在しない場合は空データとなる。
　・無料会員
　・現在が有料会員(個人)で解約中の場合
　・現在が有料会員(法人)で解約中かつ次回チケット配布がない場合
pay_end_at 契約終了日 datetime 現在のプランの契約終了日
cancel_flag 解約中フラグ int 1: 解約中
company_code 法人コード string
company_name 法人名 string
lname 氏名(姓) string
fname 氏名(名) string
lnamek ふりがな(姓) string
fnamek ふりがな(名) string
c_course 学科コード string
c_course_t 学科名 string
study_y 年制 int 1～5
c_fiscal_year 年度 int
c_sch_year 学年 int 1～6（6：既卒生）
c_year 学年名 string
c_class クラスID int

NEW!

c_login_id		 コンクールシステムログインID string

NEW!

c_user_id		 コンクールシステムユーザーID int コンクールシステムで保持している、ユーザを一意に識別する値

NEW!

services		 サービス一覧 string ,（カンマ）区切りの文字列。数値。
gender 性別 int ※値に関してはメディカパスポートの参考資料をご確認ください。
birth 生年月日 date
pref 都道府県 int ※値に関してはメディカパスポートの参考資料をご確認ください。
create_at 登録年月日 datetime  
◆JSONサンプル

{ "res": "OK", "error_code": "", "passportid": "xxxxxxxx@qript.co.jp", "passportno": "999999", "type": 0, "payed": 1, "next_payed": 1, "plan_not_changed_flag": 0, "contract_end_at": "2021-07-30 00:00", "company_code": "100000", "company_name": "株式会社クリプト", "lname": "Qript", "fname": "太郎", "lnamek": "くりぷと", "fnamek": "たろう", "gender": 1, "birth": "1978-04-20", "pref": 27, "create_at": "2019-07-29 14:59:10", "coupon_c_flag": 1 }
◆テスト送信

プロフィール取得API

  • CSサイトから利用、メディカパスポートNoを送信しプロフィール情報を返す
JSONデータ仕様
◆URL
/api/profile.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇
c_fiscal_year 年度 int

※本番環境では使用不可

指定された年度の情報を返します。
指定なしの場合は本年度の情報を返します。
◆JSONサンプル

{ "res": "OK", "error_code": "", "passportid": "xxxxxxxx@qript.co.jp", "passportno": "999999", "type": 0, "payed": 1, "company_code": "100000", "company_name": "株式会社クリプト", "lname": "Qript", "fname": "太郎", "lnamek": "くりぷと", "fnamek": "たろう", "c_course": "100", "c_course_t": "テスト学科", "c_year": "1年生", "gender": 1, "birth": "1978-04-20", "pref": 27, "create_at": "2019-07-29 14:59:10" }
◆テスト送信

教員情報取得API

  • CSサイトから利用、メディカパスポートNoを送信し教員の担当情報を返す
JSONデータ仕様
◆URL
/api/teacher.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK：認証済、NG：未認証
error_code エラーコード string 一覧
items 担当一覧 array
パラメータ 名称 タイプ 内容
c_fiscal_year 年度 int
c_sch_year 学年 int 1～6（6：既卒生）
c_class クラスID int
◆JSONサンプル
一旦なしでおねしゃす。。

購入用トークン発行API

  • CSサイトから購入予定の商品情報、金額等の情報を予めAPIに送信し購入サイトへの遷移に必要なトークンを取得
  • 購入完了時にはCSサイト向けにトークンを送信（不要であれば送信しません）
  • 取得したトークンをパラメータに付加しAPIサイトへ遷移(/order/?t=******)することで購入情報が引き継げます。
JSONデータ仕様
◆URL
/api/cart_token.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇
return_url 戻るボタン用URL string 〇

※使用用途は、APIサイト上での処理が完了していない時に、
CSサイトの特定のページに戻したい場合
complete_url マイページへ戻るボタン用URL string 〇

※使用用途は、APIサイト上で処理が完了し、
CSサイトの特定のページ（マイページなど）に戻したい場合

NEW!

last_login_date		 最終ログイン日時 datetime 〇

【2024/12/23 追加】

※GMO決済時のログイン日時パラメータ（Tds2ThreeDSReqAuthTimestamp）に使用
（YYYY-MM-DD HH:MI:SS）
code[] 商品コード string 〇
title[] 商品名 string 〇
type[] 商品種別 string 〇 item:通常商品、subscription:月額課金
payed[] 課金種別 int 〇

0 : 無料会員

1 : 有料会員(スタンダード)

2 : 有料会員(プレミアム)
billing_type[] 契約期間タイプ int 〇

0 : 月間契約（またはデフォルト）

10 : 年間契約
amount[] 数量 int 〇
price[] 単価(税抜) int 〇
tax[] 消費税額 int 〇
payload[] 商品詳細情報 string

複数の場合は 項目名[1] 項目名[2]と配列で指定

◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK、NG
error_code エラーコード string 一覧
token トークン string
◆JSONサンプル

{ "res": "OK", "error_code": "", "token": "d9b51aec3a0896dc55f281b3bebcfd11045b9e747c92c23245570a7a5015f6b9" }
◆テスト送信

◆自動購入ツール

上で発行したカートトークンの商品内容で購入情報を生成します。(1トークン1回限り)


定期購読解除API ← 202109リリースより改修

  • メディカパスポートNoを送信し定期購読を解除
JSONデータ仕様
◆URL
/api/cancel.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇 一般会員のみ利用可能。法人会員を指定した場合はNOT_FOUNDエラー
order_id 購入履歴ID int 〇
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK、NG
error_code エラーコード string 一覧
◆JSONサンプル

{ "res": "OK", "error_code": "" }
◆テスト送信

自動ログインAPI

  • CSサイトから利用、URLから取得したログイン用トークンを送信しプロフィール情報を返す。
  • 【URL例】https://library.medica.co.jp/login/?t=ZZZZZZZZZZ
  • 上記の「ZZZZZZZZZZ」部分がトークン文字列になります。パラメータ名(t)も変更可能です。
  • トークンは1回しか利用できません。また制限時間は1時間です。
JSONデータ仕様
◆URL
/api/login_token.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
token ログイン用トークン string 〇
◆JSONサンプル

{ "res": "OK", "error_code": "", "passportid": "xxxxxxxx@qript.co.jp", "passportno": "999999", "type": 0, "payed": 1, "company_code": "100000", "company_name": "株式会社クリプト", "lname": "Qript", "fname": "太郎", "lnamek": "くりぷと", "fnamek": "たろう", "gender": 1, "birth": "1978-04-20", "pref": 27, "create_at": "2019-07-29 14:59:10" }
◆テスト送信

◆トークン発行ツール

◆URL
/api/login_token_gen.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK、NG
error_code エラーコード string 一覧
token トークン string

メール送信API

  • CSサイトから利用、メールアドレスと本文をパラメータに指定すればAPIサイトから@medica.co.jpのSMTPを利用してメールを送信する。
JSONデータ仕様
◆URL
/api/mailsend.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
mailaddress メールアドレス string 〇  
body 本文 string 〇 テキストメールで送信
subject メールタイトル string 未指定の場合はメールのテンプレート管理で設定したデフォルト値が参照されます。
from_email 送信元メールアドレス string 未指定の場合はメールのテンプレート管理で設定したデフォルト値が参照されます。
from_name 送信元名 string 未指定の場合はメールのテンプレート管理で設定したデフォルト値が参照されます。
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK：認証済、NG：未認証
error_code エラーコード string 一覧
◆JSONサンプル

{ "res": "OK", "error_code": "" }
◆テスト送信

ID一覧PDF生成API

  • CSサイトから利用、「法人コード」をパラメータで渡すことで、その学校の生徒一覧のPDFのダウンロード用URLを取得。
    ※PDF生成処理は負荷が大きいのでダウンロードの直前以外では呼び出しをしないでください。
JSONデータ仕様
◆URL
/api/id_pdf.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
company_code 法人コード string 〇
passportno_t メディカパスポートNo_教員 int 〇 操作教員メディカパスポートNo
passportno メディカパスポートNo_学生 int 個別生成用の学生メディカパスポートNo
c_fiscal_year 年度 int 〇
c_sch_year 学年 int ※ ※「メディカパスポートNo_学生」が指定されない場合は必須
0～6（0：全学年、1～5：各学年、6：既卒生）
c_class クラスID int ※ ※「メディカパスポートNo_学生」が指定されない場合は必須
0～（0：全クラス、1～：各クラス）
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK：認証済、NG：未認証
error_code エラーコード string 一覧
url ダウンロード用URL string セキュリティを考慮して一定期間（数分間）しかダウンロードできません。
◆JSONサンプル

{ "res": "OK", "error_code": "", "url": "https://xxxxxxxxxxxxxxxxxxxxxxxx" }
◆テスト送信

獲得チケット確認API

  • CSサイトから利用、取得していないチケットを取得する
JSONデータ仕様
◆URL
/api/get_ticket.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇  
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK、NG
error_code エラーコード string 一覧
items 未獲得チケット array
パラメータ 名称 タイプ 内容
distribution_no 配布No int
distribution_type 配布チケット種別 int 1：有料会員（STD）、2:有料会員（プレミアム）
distribution_date 配布日時 date
◆JSONサンプル

{ "res": "OK", "error_code": "", "items": "中身は未取得のticket情報" }
◆テスト送信

配布済みチケット通知API

  • CSサイトから利用、配布済みのチケットデータをAPIへ通知する
JSONデータ仕様
◆URL
/api/distributed_ticket.json
◆パラメータ内容
パラメータ 名称 タイプ 必須 内容
api_key APIキー string 〇
passportno メディカパスポートNo int 〇  
distribution_no[] 配布No int 〇
◆返り値内容
パラメータ 名称 タイプ 内容
res 結果 string OK、NG ※NGだった場合にどうするか？
error_code エラーコード string 一覧
◆JSONサンプル

{ "res": "OK", "error_code": "", "items": "中身は未取得のticket情報" }
◆テスト送信