Link Search Menu Expand Document

7.1 - 7.10

Table of contents

  1. 7.1 Auth
  2. 7.2 Get_UserToken
  3. 7.3. Set_LoginInfo
  4. 7.4 Get_UserInfo2
  5. 7.5 Get_UserPoint
  6. 7.6. Set_UserPoint
  7. 7.7 Set_UserInfo2
  8. 7.8 Set_Password
  9. 7.9 Set_DelFlg
  10. 7.10 Get_SalesInfo

7.1 Auth

概要

各APIを実行する前に実行する。APIサーバに認証を行う。
成功すると、他コマンドの呼出しに使う為のTokenが発行される。

URL

https://(指定されたURL)/Auth.aspx

Request

必須 名前 属性 最大桁数 摘要
login_id string 20 APIにアクセスするためのシステムログインID
password string 20 APIにアクセスするためのシステムパスワード

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
Token stiring 40 トークン

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Auth.aspx?login_id=********&password=********

結果例

成功)

{"StatusCode":"0","Status":"OK","Token”:”***************”}

失敗)

{"StatusCode":"-1","Status":"ID/PASSが指定されていません"}

Status

StatusCode Status
0 OK
-1 ID/PASSが指定されていません
-2 ID/PASSが間違っています

仕様テーブル

テーブル名 内容
ZZMGR$0T_USER 参照のみ

7.2 Get_UserToken

概要

端末にTokenIDが存在しない場合、顧客が設定したログインID、パスワードを送信し、TokenIDを取得する

URL

https://(指定されたURL)/Get_UserToken.aspx

Request

必須 名前 属性 最大桁数 摘要
user_ loginid string 200 顧客が設定したログインID
user_pasword string 200 顧客が設定したパスワード

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
TokenID string 64 TokenID

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_UserToken.aspx?user_ loginid =********&user_pasword=********

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”,”TokenID”:” 06239596bbad14ad67bfe26a21abf07faedbebb7193” }

失敗)

{“StatusCode”:“-26002”,“Status”:“ログインIDが存在しません”,”TokenID”:null}

Status

StatusCode Status
0 OK
-26001 パラメータが不足しています
-26002 ログインIDが存在しません
-26003 パスワードが間違っています
-26004~-26099 内部エラー: (エラー内容詳細)

仕様テーブル

テーブル名 内容
HC$MASTER_KOKYAKU_LOGIN 参照

7.3. Set_LoginInfo

概要

ログインID、パスワード、uiud(端末固有ID)を送信し、顧客ログインマスタ、顧客マスタへの登録を行う。

URL

https://(指定されたURL)/Set_LoginInfo.aspx

Request

必須 名前 属性 最大桁数 摘要
user_loginid string 200 顧客が設定するログインID
user_pasword string 200 顧客が設定するパスワード
uuid string 300 端末固有ID
hintcode string 30 パスワード忘れ用のヒントコード  
hintans string 100 パスワード忘れ用のヒントの答え  

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
Code string 30 顧客CD
Uuid string 300 端末固有ID
TokenID string 64 TokenID

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_LoginInfo.aspx?user_loginid=********&user_pasword=********&uuid=000111222eeefff&hintcode=**&hintans=○○○

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”,”Code”:”12345678”,”Uuid”:”000111222eeefff”, ” TokenID”:”********”}

失敗)

{“StatusCode”:“-27002”,“Status”:“既に使用されているログインIDです”,”Uuid”:null}

Status

StatusCode Status
0 OK
-27001 パラメータが不足しています
-27002 既に使用されているログインIDです
-27003 ログインIDに使用不可能な文字列が含まれています(半角英数字のみ20桁)
-27004 パスワードに使用不可能な文字列が含まれています(半角英数字のみ20桁)
-27005~-27099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_MEISHO 参照(名称区分=’KY1’ and 名称CD=’01’)、修正 (連番 = 連番+1)
HC$MASTER_KOKYAKU_LOGIN 追加 (ログインID = user_loignid, PASS = user_pasword, UUID = uuid,
顧客CD = 新規追加されたHC$master_kokyakuの顧客CD,
TOKEN = 新規追加されたTOKEN, ヒントCD = hintcode,
ヒントの答え = hintans)
HC$MASTER_KOKYAKU 追加 (顧客CD = HC$MASTER_MEISHO
(名称区分=’KY1’ and 名称CD=’01’)の連番,
顧客区分 = 0, 会員登録日 = api実行日, 最終更新日 = api実行日)

7.4 Get_UserInfo2

概要

TokenID、uuid(端末固有ID)を送信し、顧客マスタの情報を取得する。

URL

https://(指定されたURL)/Get_UserInfo2.aspx

Request

必須 名前 属性 最大桁数 摘要
tokenid string 64 顧客識別用トークンID
uuid string 300 端末固有ID

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
User (class)   顧客データ
Code string 30 顧客CD
Name string 100 顧客名
Kana string 80 カナ
PostalCode string 30 郵便番号
Address1 string 200 住所1
Address2 string 200 住所2
Address3 string 200 住所3
Tel1 string 40 TEL1
Tel2 string 40 TEL2
Email string 200 Eメール
Rank string 8 ランク
Shop string 8 店舗 CD
Birth string 8 誕生日 YYYYMMDD
Memo string 60 メモ
Gender int 1 性別 0 未設定、1女性、2 男性
Point int 10 ポイント残高
Tanto string 20 販売員CD
TotalShopCount Int 10 累計来店回数
TotalSalesCount Int 10 累計購入数量
TotalSalesAmount Int 10 累計購入金額
Segment Int 1 顧客区分
0未使用、1 スマホ、2 ガラケー、9会員情報未登録
Division01 string 20 名称CD01
Division02 string 20 名称CD02
Division03 string 20 名称CD03
Division04 string 20 名称CD04
Division05 string 20 名称CD05
Division06 string 20 名称CD06
Division07 string 20 名称CD07
Division08 string 20 名称CD08
Division09 string 20 名称CD09
Division10 string 20 名称CD10
ExpandMemo string 400 拡張メモ
Tanto2 string 8 入力社員CD
LastShopDate string 8 最終来店日YYYYMMDD
LastYearPoint int 10 前年ポイント (HC$REAL_POINTテーブル)
ResistDate string 8 会員登録日YYYYMMDD
ResistDate string 8 会員登録日YYYYMMDD
Attribute1 (class)   顧客属性1(配列)
AttrId string 10 属性ID
AttrName string 20 属性名
Attribute2 (class)   顧客属性2(配列)
AttrId string 10 属性ID
AttrName string 20 属性名
LoginId string 200 ログインID
HintCode string 30 パスワード忘れ用のヒントコード
HintAns string 100 パスワード忘れ用のヒントの答え

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_UserInfo2.aspx? tokenid =********&uuid=000111222eeefff

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”,”User”:{“Code”:”1234567890123”,”Name”:”岡本”,”Kana”:”オカモト”,……,”Attribute1”:[{“AttrID”:”01”,”AttrName”:”ブランド1”,…},{…}],”Attribute2”:[{“AttrID”:”0001”,”AttrName”:”新宿店”,…},{…}],”LoginId”:”890”,”HintCode”.”01”,”HintAns”.”岡本”}}

失敗)

{“StatusCode”:“-31002”,“Status”:“ログインIDが存在しません”,”User”:null}

Status

StatusCode Status
0 OK
-31001 パラメータが不足しています
-31002 ログインIDが存在しません
-31003 パスワードが間違っています
-31004~-31099 内部エラー: (エラー内容詳細)

7.5 Get_UserPoint

概要

顧客CDあるいは顧客電話番号を送信し、顧客マスタのポイント情報を取得する。

URL

https://(指定されたURL)/Get_UserPoint.aspx

Request

必須 名前 属性 最大桁数 摘要
  user_code string 30 顧客CD
  user_tel string 40 顧客電話番号
※顧客マスタのTEL1かTEL2

※どちらか一方のみをセットする。両方パラメータにセットされた場合にはuser_codeが優先される

Response

名前 属性 最大桁数 摘要  
StatusCode int 6 ステータスコード  
Status string 200 ステータス内容  
UserPoint (class) 顧客データ(配列)    
Code string 30 顧客CD  
Name string 100 顧客名  
RankCode string 8 ランクコード  
RankName string 100 ランク名称  
PointRate int 3 ポイント掛率(10倍にして送信)  
Shop string 8 店舗CD  
Birth string 8 誕生日  
Memo string 400 メモ  
Gender int 1 性別 0 未設定、1 女性、2 男性
Point int 10 ポイント残高  

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_UserPoint.aspx?user_code=1234567890123 
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_UserPoint.aspx?user_tel=09011112233

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”,”UserPoint”:[{“Code”:”1234567890123”,”Name”:”岡本”,”RankCode”:”5”,”RankName”:”E”,”PointRate”:”11”,”Shop”:”001122”,”Birth”:”19910101”,”Memo”:”.”,”Gender”:”0”,”Point”:”4250” }]}

失敗)

{“StatusCode”:“-8002”,“Status”:“顧客CDが存在しません”,”UserPoint”:null}

Status

StatusCode Status
0 OK
-8001 パラメータが不足しています
-8002 顧客CDが存在しません
-8003 顧客TELが存在しません
-8004 退会済み顧客です
-8005~-8099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_KOKYAKU_LOGIN 参照
HC$MASTER_KOKYAKU 参照
HC$POINT_REAL 参照

7.6. Set_UserPoint

概要

Posレジにて顧客が獲得、使用したポイントをDTPの基幹システムへ送信し更新を行う

URL

https://(指定されたURL)/Set_UserPoint.aspx

Request

必須 名前 属性 最大桁数 摘要
user_code string 30 顧客CD
sales_date string 8 売上日
sales_division string 2 取引区分 (10:売上、20:返品)
sales_shop string 8 店舗CD
register_no int 14 レジNO
receipt_no int 14 レシートNO
get_point int 10 獲得ポイント数(返品の場合はマイナス値)
use_point int 10 使用ポイント数(返品の場合はマイナス値)
user_remarks string 200 備考

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_UserPoint.aspx?user_code=1234567890123&sales_date=20140401&sales_division=10&sales_shop=100200&register_no=123&receipt_no=556&get_point=234&use_point=500

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”}

失敗)

{“StatusCode”:“-9002”,“Status”:“顧客CDが存在しません”}

Status

StatusCode Status
0 OK
-9001 パラメータが不足しています
-9002 顧客CDが存在しません
-9003 店舗CDが存在しません
-9004~-9099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_TOKUI 参照
HC$TRAN_POINT_RIREKI 追加(顧客CD = user_code, ランク = HC$master_kokyakuのポイントランク,
ポイント計上日 = sales_date, 店舗CD = sales_shop, レジNO = register_no,
レシートNO = receipt_no, 取引区分 = sales_division, 発生区分 = 0,
付与ポイント数 = get_point, 使用ポイント数 = use_point, 備考 = memo)
HC$POINT_REAL 修正(Realポイント = 元のRealポイント + get_point - use_point)
HC$MASTER_KOKYAKU 修正
顧客区分が0のときのみ 顧客区分 = 9

7.7 Set_UserInfo2

概要

顧客情報の変更を行う。

URL

https://(指定されたURL)/Set_UserInfo2.aspx

Request

必須 名前 属性 最大桁数 摘要
Tokenid string 64 顧客識別用トークンID
user_code string 30 顧客CD
  Name string 100 顧客名
  Kana string 80 カナ
  Postalcode string 30 郵便番号
  address1 string 200 住所1
  address2 string 200 住所2
  address3 string 200 住所3
  tel1 string 40 TEL1
  tel2 string 40 TEL2
  Email string 200 Eメール
  Shop string 8 店舗CD
  Birth string 8 誕生日
  Memo string 60 メモ
  Gender int 1 性別
0 未設定、1 女性、2 男性
  Tanto string 20 販売員 CD
Segment int 1 顧客区分
  division01 string 20 名称CD01
  division02 string 20 名称CD02
  division03 string 20 名称CD03
  division04 string 20 名称CD04
  division05 string 20 名称CD05
  division06 string 20 名称CD06
  division07 string 20 名称CD07
  division08 string 20 名称CD08
  division09 string 20 名称CD09
  division10 string 20 名称CD10
  expandmemo string 400 拡張メモ
  Resistdate string 8 会員登録日(yyyyMMdd)
  Attribute1 (class)   顧客属性1(配列) ブランド固定
  AttrId string 10 属性ID     (ブランドコード)
  AttrName string 100 属性名 (ブランド名) ※マスタ管理なので設定しても無視
  Attribute2 (class)   顧客属性2(配列) 店舗固定
  AttrId string 10 属性ID     (店舗コード)
  AttrName string 100 属性名 (店舗名) ※マスタ管理なので設定しても無視
  hintcode string 30 パスワード忘れ用のヒントコード
  hintans string 100 パスワード忘れ用のヒントの答え
  rank int 4 ポイントランク

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
User (class) 顧客データ 顧客属性2(配列) 店舗固定
Code string 30 顧客CD
Name string 100 顧客名
Kana string 80 カナ
PostalCode string 30 郵便番号
Address1 string 200 住所1
Address2 string 200 住所2
Address3 string 200 住所3
Tel1 string 40 TEL1
Tel2 string 40 TEL2
Email string 200 Eメール
Rank string 4 ランク
Shop string 8 店舗CD
Birth string 8 誕生日
Memo string 60 メモ
Gender int 1 性別
0 未設定、1女性、2 男性
Point int 10 ポイント残高
Tanto string 20 販売員CD
TotalShopCount int 10 累計来店回数
TotalSalesCount int 10 累計購入数量
TotalSalesAmount int 10 年間累計購入金額
Segment int 1 顧客区分 1 スマートフォン
Division01 string 20 名称CD01
Division02 string 20 名称CD02
Division03 string 20 名称CD03
Division04 string 20 名称CD04
Division05 string 20 名称CD05
Division06 string 20 名称CD06
Division07 string 20 名称CD07
Division08 string 20 名称CD08
Division09 string 20 名称CD09
Division10 string 20 名称CD10
ExpandMemo string 400 拡張メモ
Tanto2 string 20 入力社員CD
LastShopDate string 8 最終来店日
LastYearPoint int 10 前年ポイント
ResistDate string 8 会員登録日
Attribute1 (class) 顧客属性1(配列) 名称CD01
AttrId string 10 属性ID
AttrName string 100 属性名
Attribute2 (class) 顧客属性2(配列) 名称CD04
AttrId string 10 属性ID
AttrName string 100 属性名
LoginId string 200 ログインID
HintCode string 30 パスワード忘れ用のヒントコード
HintAns string 100 パスワード忘れ用のヒントの答え

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_UserInfo2.aspx? tokenid =********& user_code= 0123456789123& name=DTP 花子&tel1=09012341234&tel2=0312345555,.., &Attribute1=[{"AttrId":"01","AttrName":"ブランド1"},{"AttrId":"02","AttrName":"ブランド2"},…]&hintcode=02&hintans=あいうえお

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”,”User”:{“Code”:”1234567890123”,”Name”:”岡本”,”Kana”:”オカモト”,……,”Attribute1”:[{“AttrID”:”01”,”AttrName”:”ブランド1”,…},{…}],”Attribute2”:[{“AttrID”:”0001”,”AttrName”:”新宿店”,…},{…}],”LoginId”:”890”,”HintCode”:”xxx”,”HintAns”:”xxxx”}}

失敗)

{“StatusCode”:“-28002”,“Status”:“ログインIDが存在しません”,”User”:null}

Status

StatusCode Status
0 OK
-28001 パラメータが不足しています
-28002 ログインIDが存在しません
-28003 顧客CDが存在しません
-28004~-28099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_KOKYAKU_LOGIN 参照、修正(ヒントCD = hintcode,ヒントの答え = hintans)
HC$MASTER_KOKYAKU 参照、修正(入力パラメータで指定された項目)
会員登録日が’.’または’19010101’の場合は、api実行日をセット
最終更新日 = api実行日
HC$KOKYAKU_ZOKUSEI 入力パラメータ Attribute1 があった場合更新(全削除&追加)
顧客CD = user_code
属性ID = Attribute1のAttrId
属性CD = 1

7.8 Set_Password

概要

パスワードの変更を行う。

URL

https://(指定されたURL)/Set_Password.aspx

Request

必須 名前 属性 最大桁数 摘要
tokenid string 64 顧客識別用トークンID
user_pasword string 200 既存顧客パスワード
user_new_pasword string 200 顧客が変更したパスワード
user_code string 30 顧客CD

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
tokenid string 64 新規顧客識別用トークンID

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_Password.aspx?tokenid=************&user_password=********& user_new_password=********&user_code=12345697890123

結果例

成功)

{"StatusCode":"0","Status":"OK"," tokenid”:”***************”}

失敗)

{“StatusCode”:“-32002”,“Status”:“ログインIDが存在しません”}

Status

StatusCode Status
0 OK
-32001 パラメータが不足しています
-32002 ログインIDが存在しません
-32003 パスワードが間違っています
-32004~-32099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_KOKYAKU_LOGIN 参照、修正 (PASS = user_new_pasword)
HC$MASTER_KOKYAKU 参照

7.9 Set_DelFlg

概要

退会処理を行う。

URL

https://(指定されたURL)/Set_DelFlg.aspx

Request

必須 名前 属性 最大桁数 摘要
tokenid string 64 顧客識別用トークンID
user_code string 30 顧客CD

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_DelFlg.aspx? tokenid =********&user_code=12345697890123

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”}}

失敗)

{“StatusCode”:“-34002”,“Status”:“ログインIDが存在しません”}

Status

StatusCode Status
0 OK
-34001 パラメータが不足しています
-34002 ログインIDが存在しません
-34003 顧客CDが存在しません
-34004 他で修正されているため削除できません。
-34005~-34099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_KOKYAKU_LOGIN 参照、削除
HC$MASTER_KOKYAKU 修正 (退会FLG = 1, 退会日 = api実行日, 最終更新日 = api実行日,属性情報4 = 1)

7.10 Get_SalesInfo

概要

購買履歴の取得を行う

URL

https://(指定されたURL)/Get_SalesInfo.aspx

Request

必須 名前 属性 最大桁数 摘要
tokenid string 64 顧客識別用トークンID
user_code string 30 顧客CD
month string 8 年月(YYYYMM) ※指定年月を含む、それ以前の購買履歴が対象
count string 3 取得件数

Response

名前 属性 最大桁数 摘要
StatusCode int 6 ステータスコード
Status string 200 ステータス内容
Sales (class)   売上データ(配列) 購買年月日の降順
SalesDate string 8 購買年月日(yyyyMMdd)
ShopCode string 8 店舗CD
ShopName string 100 店舗名
GoodsName string 100 商品名
ColorName string 100 色名
SizeName string 100 サイズ名
Category string 100 カテゴリ (アイテム名)
Brand string 100 ブランド名
Price int 10 売価
Quantity int 10 数量
Amount int 10 金額

実行例

http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_SalesInfo.aspx? tokenid=***********&user_code=12345697890123&month=201404

結果例

成功)

{“StatusCode”:“0”,“Status”:“OK”,”Sales”:{[“SalesDate”:”20140401”,”ShopCode”:”0001”,”ShopName”:”池袋店”,”Goods”:”Tシャツ”,……}]}

失敗)

{“StatusCode”:“-33002”,“Status”:“顧客CDが存在しません”,”Sales”:null}

Status

StatusCode Status
0 OK
-33001 パラメータが不足しています
-33002 顧客CDが存在しません
-33003 指定範囲の売上データがありません。
-33004~-33099 内部エラー: (エラー内容詳細)

使用テーブル

テーブル名 内容
HC$MASTER_KOKYAKU_LOGIN 参照
HC$MASTER_KOKYAKU 参照
HC$TRAN_TORI0 参照
HC$TRAN_TORI1 参照