Pococa API Ver 1.29 マニュアル

会員カードAPI

URL:http://www.pococa.com/api/membercard/

会員カード検索

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 MembercardSearch
searchtype 検索タイプ 検索タイプを指定します。 Shop:更新順検索
Rank:取得ランキング検索
offset 開始位置 条件に合う会員カードの何番目から取得するかを指定します。 0から始まる整数値
count 取得件数 条件に合う会員カードを開始位置から何件取得するかを指定します。 1から始まる整数値
shopcategory 店舗カテゴリ 店舗カテゴリーを絞り込みます。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
areacategory 地域カテゴリ 地域カテゴリーを絞り込みます。
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
isshopcategoryrecursive 店舗カテゴリ再帰検索フラグ 指定された店舗カテゴリーの子孫に属する店舗まで再帰検索をするかどうかを指定します。 1:指定された店舗カテゴリー(shopcategory)以下すべての階層(子、孫など)の店舗を検索対象とします。
1以外:指定された店舗カテゴリー(shopcategory)に直接属する店舗のみを検索対象とします。
isareacategoryrecursive 地域カテゴリ再帰検索フラグ 指定された地域カテゴリーの子孫に属する地域まで再帰検索をするかどうかを指定します。 1:指定された地域カテゴリー(areacategory)以下すべての階層(子、孫など)の地域を検索対象とします。
1以外:指定された地域カテゴリー(areacategory)に直接属する地域のみを検索対象とします。
membercardattr 会員カード属性 会員カード属性を指定します。 0:すべて
0以外:それぞれの会員カード属性
※複数指定する場合はカンマ(,)区切りで指定して下さい。
keyword 検索キーワード 検索するキーワードを指定します。 文字エンコードをUTF-8で指定して下さい。
※半角スペースで区切ることでAnd検索を行うことができます。
apikey APIキー文字列 APIキー文字列を指定します。(流通パートナーのみ必要なパラメータです。) 流通パートナー契約時にお知らせします。

レスポンス

フィールド 説明 出現回数
membercardlist 会員カードリスト 1
membercardinfo 会員カード情報 表示件数分
shopid 店舗ID 1 1
shopname 店舗名 1 Pococa!運営事務局
shopimageurl 店舗画像URL 1 http://www.pococa.com/system/shopimages/1-20090628-190637.jpg
information お知らせ 1 ただいま加盟店続々増加中です。ポコカをどんどん活用してください
privilege 会員特典 1 1.ポコカ運営事務局からのお知らせが届きます。
2.ポコカオリジナルクーポンが届きます。
3.イベント情報速報が届きます。


membercardimageurl 会員カード画像URL 1 http://www.pococa.com/system/shopcardimages/1-cardimage-20090628-190637.jpg
membercarddownloadurl 会員カードダウンロード用URL 1
http://www.pococa.com/i/do/pccstcpnymember?guid=ON&seq_m_cpny=1
qrcodeurl QRコード用URL 1
http://www.pococa.com/sys/do/qrcode?seq_m_cpny=1
cat_visiblecardstate 閲覧可能ステータス
(1:一般 2:ポコカ会員 3:店舗会員)
1 1

会員カード数取得

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 MembercardCount
shopcategory 店舗カテゴリ 店舗カテゴリーを絞り込みます。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
areacategory 地域カテゴリ 地域カテゴリーを絞り込みます。
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。
isshopcategoryrecursive 店舗カテゴリ再帰検索フラグ 指定された店舗カテゴリーの子孫に属する店舗まで再帰検索をするかどうかを指定します。 1:指定された店舗カテゴリー(shopcategory)以下すべての階層(子、孫など)の店舗を検索対象とします。
1以外:指定された店舗カテゴリー(shopcategory)に直接属する店舗のみを検索対象とします。
isareacategoryrecursive 地域カテゴリ再帰検索フラグ 指定された地域カテゴリーの子孫に属する地域まで再帰検索をするかどうかを指定します。 1:指定された地域カテゴリー(areacategory)以下すべての階層(子、孫など)の地域を検索対象とします。
1以外:指定された地域カテゴリー(areacategory)に直接属する地域のみを検索対象とします。
membercardattr 会員カード属性 会員カード属性を指定します。 0:すべて
0以外:それぞれの会員カード属性
※複数指定する場合はカンマ(,)区切りで指定して下さい。
keyword 検索キーワード 検索するキーワードを指定します。 文字エンコードをUTF-8で指定して下さい。
※半角スペースで区切ることでAnd検索を行うことができます。

レスポンス

フィールド 説明 出現回数
membercardcountinfo 会員カード数情報 1
count 会員カード数 1 1

会員カード情報取得

リクエスト(sid任意:閲覧可能ステータスに対応するためには必要)

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 MembercardInfo
shopid 店舗ID 取得するメンバーカードの店舗IDを指定します。 1
apikey APIキー文字列 APIキー文字列を指定します。(流通パートナーのみ必要なパラメータです。) 流通パートナー契約時にお知らせします。

レスポンス

フィールド 説明 出現回数
membercardinfo 会員カード情報 1
shopid 店舗ID 1 1
shopname 店舗名 1 Pococa!運営事務局
shopimageurl 店舗画像URL 1 http://www.pococa.com/system/shopimages/1-20090628-190637.jpg
information お知らせ 1 ただいま加盟店続々増加中です。ポコカをどんどん活用してください
privilege 会員特典 1 1.ポコカ運営事務局からのお知らせが届きます。
2.ポコカオリジナルクーポンが届きます。
3.イベント情報速報が届きます。
membercardimageurl 会員カード画像URL 1 http://www.pococa.com/system/shopcardimages/1-cardimage-20090628-190637.jpg
membercarddownloadurl 会員カードダウンロード用URL 1
http://www.pococa.com/i/do/pccstcpnymember?guid=ON&seq_m_cpny=1
cat_visiblecardstate 閲覧可能ステータス
(1:一般 2:ポコカ会員 3:店舗会員)
1 1
visiblecardstate 閲覧可能情報 1 一般ユーザーが閲覧可能です。
isvisiblecard

カード情報取得結果ステータス
(可:true、不可:false)

1 true
isname

会員情報(名前)必須項目フラグ
(必須:true、不要:false)

1 false
isaddr

会員情報(住所)必須項目フラグ
(必須:true、不要:false)

1 false
istelno

会員情報(TEL)必須項目フラグ
(必須:true、不要:false)

1 false
isemail

Eメール(E−MAIL)必須項目フラグ
(必須:true、不要:false)

1 false

会員カードカテゴリ検索

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 MembercardCategorySearch
searchtype 検索タイプ 検索タイプを指定します。 ParentSearch:指定カテゴリーからTopカテゴリーまで親カテゴリーを再帰的に検索します。(指定カテゴリーを含む)
ChildSearch:指定カテゴリーから末端のカテゴリーまで子カテゴリーを再帰的に検索します。(指定カテゴリーを含まない)
shopcategory 店舗カテゴリ 基準となる店舗カテゴリを指定します。
※店舗カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの店舗カテゴリー
areacategory 地域カテゴリー 基準となる地域カテゴリを指定します
※地域カテゴリーについてはこちらを参照して下さい。
0:すべて
0以外:それぞれの地域カテゴリー
※複数指定する場合はカンマ(,)区切りで指定して下さい。

レスポンス

フィールド 説明 出現回数
membercardcategorylist 会員カードカテゴリーリスト 1
membercardcategoryinfo 会員カードカテゴリー情報 表示件数分
shopcategoryid 店舗カテゴリID 1 1
shopcardcategoryname 店舗カテゴリ名 1 グルメ
membercardcount 会員カード数 1 34

会員カード属性取得

リクエスト

パラメータ 項目名 説明
operation オペレーションコード APIに行わせる操作の種類を指定します。 MembercardAttr

レスポンス

フィールド 説明 出現回数
membercardattrlist 会員カード属性リスト 1
membercardattrinfo 会員カード属性情報 表示件数分
membercardttrid 会員カード属性ID 1 1
membercardattrname 会員カード属性名 1 ポイントカード機能
membercardcount 会員カード数 1 5

Copyright(c) ZEAD Co.,Ltd. 2012, All rights reserved.