たぽろだ市場APIドキュメント

クイックリンク：パラメータ一覧エラーコード一覧

■たぽろだ市場API■

たぽろだの配布スクリプトは、アップロードされた商品の情報をたぽろだ市場に送信する機能を持っています。この機能は、たぽろだがたぽろだ市場を運営している「中央管理サーバー」上に用意されたたぽろだ市場API を呼び出す事で実現しています。

このページでは、たぽろだ市場APIの機能とパラメータ、正常/エラー時のステータスを解説いたします。

■利用可能なAPI■
現在は、商品情報登録用のAPIのみ提供しています。

商品情報登録用のAPIは、商品情報の登録機能、たぽろだに関する情報登録機能を持っています。

■商品情報登録用API(詳細)■
URLは次の通りです。

    http://up.moritapo.jp/tapoloda/cent/er/r1/jumbo.html

このURLに後述するパラメータを設定し、HTTPのGETリクエストを行うことで機能を実行できます。

提示されているパラメータは全て必須です。足りないパラメータがある場合、エラーとなって登録は失敗します。

APIは、パラメータのチェックを行い、それが終わるとたぽろだの情報が登録済みかどうかを確認します。未登録の場合は、たぽろだ情報を登録します。登録済みの場合、たぽろだ名とたぽろだ管理手数料が変わっていた場合は更新を行います。 (更新されると、たぽろだ一覧に最終更新日が表示されます)

最後に、送信された商品情報を保存します。

全ての処理が正常に終わると、

OK

と、テキストで値を返します。
もし、処理の途中でエラーになった場合、

  NG 321 TAPO_ERR_PARAM_FORMAT_FLN

とエラーが返ります。スペース区切りで先頭は常に「NG」の文字列。次がエラー番号、最後がエラーコードになります。エラーについては、このページの最後にまとめていますので必要に応じてご参照ください。

■パラメータ一覧■ [TOPへ]

パラメータ名

呼称

説明

たぽろだスクリプト設定値

最大長(※1)

svm

管理者メールアドレス

たぽろだスクリプトに設定された管理者メールアドレスです。

この値とたぽろだID を組み合わせ、一つのIDを中央管理サーバー内で発行し、たぽろだを識別しています。

設定ファイルの
$SK_MORITAPI_MAILを使います。

512

たぽろだID

たぽろだスクリプトに設定された、たぽろだを識別するためのIDです。

この値と管理者メールアドレスを組み合わせ、一つのIDを中央管理サーバー内で発行し、たぽろだを識別しています。
指定出来る文字は半角英数字(大文字/小文字は別文字として扱う)です。
(2009/09/02 追加)

設定ファイルの
$TAPOLODA_IDを使います。

8
固定

url

たぽろだURL

たぽろだスクリプトのURLです。

サーバー移転に併せてここのURLを変更すると、市場に出品されている商品のURLも一律変更されます。

設定ファイルの$CGI_URLを使います。(サーバー環境変数は全く見ていません)

128

itn

たぽろだ名

たぽろだに付けられた名称です。商品一覧やたぽろだ一覧で使われます。

URLエンコードが必要です。

設定ファイルの$BBS_NAMEを使います。

192

itt

たぽろだ管理手数料

たぽろだに設定された管理手数料です。

パラメータで受け取った値は、100倍されてからたぽろだ一覧に表示されます。

設定ファイルの$BBS_CHARGEを使います。

own

うｐ主の名前

うｐ主の名前です。商品一覧で使われます。

URLエンコードが必要です。

たぽろだのアップロードフォームの「お名前」欄の値を使います。

144

ttl

商品名

商品名です。商品一覧で使われます。

URLエンコードが必要です。

たぽろだのアップロードフォームの「タイトル」欄の値を使います。

765

dsc

説明

商品に対する説明です。商品一覧で使われます。

URLエンコードが必要です。

たぽろだのアップロードフォームの「説明」欄の値を使います。
説明文が長い場合は、タグ等の不要な文字を取り除いた上で76byteまで切り詰めた後に" ..."を文字列の後ろに追加して、説明文としています。

384

ctb

カテゴリID

商品分類するためのカテゴリで、中央管理サーバーで取り扱っているIDです。商品一覧で使われます。

中央管理サーバーで使われていないIDが指定された場合、APIは登録を中止し、エラーコードを返します。

現在定義されているカテゴリIDは以下の通りです。

ID	名称
10	画像
20	動画
30	音
40	文書
50	ﾌﾟﾛｸﾞﾗﾑ
90	その他
15	(18禁)画像
25	(18禁)動画
35	(18禁)音
45	(18禁)文書
55	(18禁)ﾌﾟﾛｸﾞﾗﾑ
95	(18禁)その他

IDは運営側で定義しているため、たぽろだ側で任意に変更する事は出来ません。変更や追加がある場合は、公式サイトにてアナウンスを行います。

たぽろだのアップロードフォームの「カテゴリ」欄の値を使います。

cts

任意カテゴリ

商品分類するためのカテゴリで、うｐ主が任意に設定できる物です。商品一覧で使われます。

URLエンコードが必要です。

たぽろだのアップロードフォームの「任意カテゴリ」欄の値を使います。

765

amn

ダウンロードに必要なモリタポ

うｐ主がアップロードファイルに付けた、ダウンロードに必要なモリタポの数です。商品一覧で使われます。

たぽろだのアップロードフォームの「ダウンロードに必要なモリタポ」欄の値を使います。

itm

mime-type

アップロードされたファイルのMIME-TYPEです。

将来、商品一覧の改良を行う際に使用する予定です。

たぽろだスクリプトがブラウザからのリクエストで受け取ったMIME-TYPEを使います。

fln

ファイル実名

アップロードされたファイルの実際の名前です。商品一覧で使われます。

URLエンコードが必要です。

なお、ファイル名は次の正規表現にマッチしない場合は登録に失敗します。

   /\.([a-z0-9_]+)$/i

この正規表現を簡単に説明すると「拡張子の付いていないファイル名は登録できない」ということです。
しかし、厳密にチェックを行っているわけではなく、「(ファイル実名は)末尾に、'.'(ドット)と、その後に大文字小文字を問わない半角a～zまでの文字と半角数字、'_'(アンダースコア)で構成される複数文字にマッチする」という条件を満たしていればフォーマット的にはOKとしています。

たとえば、

  file_name.zip

これはOKです。

  file_name.mp3

これもOKです。しかし、

  file_name.

これはNGです。

zzz

これもNGです。なお、

  file_name.too_match_long_exp

これはOKとなります。つまり、拡張子の長さに規定はありません。 url_encode後のファイル実名全体の長さが規定内に収まっていればOKです。

拡張子情報を取得している理由は、mime-typeとセットでたぽろだ市場の機能拡張の為に取得しています。

たぽろだスクリプトが、
ブラウザからのリクエストで受け取ったファイル名を使います。

753

fli

ファイルID

たぽろだスクリプトが管理で使っている、アップロードされたファイルのIDです。商品一覧のファイルへのリンクで使われます。

アップロード処理時に割り当てたIDを使います。

upd

登録日

たぽろだスクリプトにアップロードされた日付です。商品一覧で使われます。

日付のフォーマットは YYYYMMDD.hhmmss です。例：2008年12月5日 7時56分43秒の場合は 20081205.075643 になります。

アップロード処理の実行開始時刻を使います。

rld

公開期限日

アップロードファイルの公開期限日です。商品一覧で使われます。

日付のフォーマットは登録日と同様 YYYYMMDD.hhmmss です。
ただし、特別な日付として、99999999.999999 が指定された場合は「無期限」とします。

たぽろだのアップロードフォームの「公開期限」欄の値を使います。

※1：最大長はパラメータ値のバイト数で、url_encodeが必要な場合はurl_encode後の文字列長を表します。
※パラメータの文字列エンコードはShift-JISです。

■エラーコード一覧■ [TOPへ]

エラー番号	エラーコード	エラー名称	説明
010	TAPO_ERR_MODE_OR_URL	URLの指定間違い	APIのURLが不正か、間違っている場合にこのエラーが起きます。リクエストしているURLに間違いが無い事を確認してください。
110	TAPO_ERR_PARAM_NA_SVM	パラメータ無し	パラメータが必要なのに、設定されていない場合にこのエラーが起きます。
111	TAPO_ERR_PARAM_NA_URL
112	TAPO_ERR_PARAM_NA_ITN
113	TAPO_ERR_PARAM_NA_ITT
114	TAPO_ERR_PARAM_NA_OWN
115	TAPO_ERR_PARAM_NA_TTL
116	TAPO_ERR_PARAM_NA_DSC
117	TAPO_ERR_PARAM_NA_CTB
118	TAPO_ERR_PARAM_NA_CTS
119	TAPO_ERR_PARAM_NA_AMN
120	TAPO_ERR_PARAM_NA_ITM
121	TAPO_ERR_PARAM_NA_FLN
122	TAPO_ERR_PARAM_NA_FLI
123	TAPO_ERR_PARAM_NA_UPD
124	TAPO_ERR_PARAM_NA_RLD
125	TAPO_ERR_PARAM_NA_ID
210	TAPO_ERR_PARAM_LENGTH_SVM	パラメータ文字列長エラー	パラメータの文字列長が大きすぎた場合にこのエラーが起きます。各パラメータの指定可能なサイズを確認してください。
211	TAPO_ERR_PARAM_LENGTH_URL
212	TAPO_ERR_PARAM_LENGTH_ITN
213	TAPO_ERR_PARAM_LENGTH_ITT
214	TAPO_ERR_PARAM_LENGTH_OWN
215	TAPO_ERR_PARAM_LENGTH_TTL
216	TAPO_ERR_PARAM_LENGTH_DSC
217	TAPO_ERR_PARAM_LENGTH_CTB
218	TAPO_ERR_PARAM_LENGTH_CTS
219	TAPO_ERR_PARAM_LENGTH_AMN
220	TAPO_ERR_PARAM_LENGTH_ITM
221	TAPO_ERR_PARAM_LENGTH_FLN
222	TAPO_ERR_PARAM_LENGTH_FLI
223	TAPO_ERR_PARAM_LENGTH_UPD
224	TAPO_ERR_PARAM_LENGTH_RLD
225	TAPO_ERR_PARAM_LENGTH_ID
310	TAPO_ERR_PARAM_FORMAT_SVM	パラメータフォーマットエラー	パラメータのフォーマットがおかしい場合にこのエラーが起きます。
311	TAPO_ERR_PARAM_FORMAT_URL
312	TAPO_ERR_PARAM_FORMAT_ITN
313	TAPO_ERR_PARAM_FORMAT_ITT
314	TAPO_ERR_PARAM_FORMAT_OWN
315	TAPO_ERR_PARAM_FORMAT_TTL
316	TAPO_ERR_PARAM_FORMAT_DSC
317	TAPO_ERR_PARAM_FORMAT_CTB
318	TAPO_ERR_PARAM_FORMAT_CTS
319	TAPO_ERR_PARAM_FORMAT_AMN
320	TAPO_ERR_PARAM_FORMAT_ITM
321	TAPO_ERR_PARAM_FORMAT_FLN
322	TAPO_ERR_PARAM_FORMAT_FLI
323	TAPO_ERR_PARAM_FORMAT_UPD
324	TAPO_ERR_PARAM_FORMAT_RLD
325	TAPO_ERR_PARAM_FORMAT_ID
410	TAPO_ERR_PARAM_BCATE	カテゴリID指定エラー	カテゴリIDが間違っています。
411	TAPO_ERR_PARAM_ASSOC_DATE	日付の相関関係エラー	登録日と公開期限日の大小関係が間違っています。登録日は公開期限日よりも前の日付が指定されていないとエラーになります。
990	SERVICE_NOT_AVAILABLE	サービス停止中	サービスが停止されています。しばらく時間を空けてから、再度アクセスしてください。
その他900番台	SYSTEM_ERR	システムエラー	システム側のトラブルで、エラーになった場合はこのエラーが起きます。しばらく時間を空けてから、再度アクセスしてください。