lms-他システム連携/API

13-03-18.クーポンコードチェックAPI

投稿日:

API名 クーポンコードチェックAPI
ID el_couponCode_check_api

2.詳細解説

入力されたクーポンコードが有効かどうかをチェックするためのAPI。申込画面を開発する際、当システムのクーポン機能を利用している場合、商品情報取得APIで設定されたクーポンのIDが取得できる。そのクーポンIDと申込者が画面から入力したクーポンコードをINPUTにいれ、クーポンコードの妥当性を判断する。

$cstream->call_el_couponCode_check_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
3   アクセスキー access_key APIを認証するためのアクセスキー
4   商品ID product_id  
5   クーポンNo coupon_no  
5   クーポンコード coupon_code  

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   成功フラグ success_flg クーポンコードが正しく認証された場合1を返す。エラーは0

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させるException
0 アクセスキー不適合エラー アクセスキーが適合しません。 AccessKeyException
1 ホスト許可エラー 対象のホストからのAPI実行を許可していません。 HostRestrictException
2 引数エラー 呼出パラメータが不足しているため実行できません。 CallParameterException
9 システムメンテナンスエラー 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 SystemMaintenanceException

4.実装例

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.