ご利用ガイド

  • 検索APIとは?
  • アプリケーション・プログラミング・インターフェース (Application Programming Interface) の略で、ソフトウェアやプログラム、Webサービスの間をつなぐインターフェースのことを指します。当サイトでは主にJANコードをはじめとするバーコード(JAN/EAN/ISBN/UPCに対応)に関連する商品情報を対象とした検索APIを提供しています。

  • アプリIDについて
  • 当サービスの提供するAPIに接続するための認証キーの事を指します。

    こちらから会員登録することで発行可能です。

  • クレジット表記について
  • 当サービスのAPIを利用してサイトを公開する場合は、当サイトへのリンクをお願いいたします。

    リンク先: https://www.jancodelookup.com/

    リンクテキスト: Web Services by JANCODE LOOKUP

  • ご利用料金について
  • 24時間あたり5,000リクエストまで無料でご利用いただくことができます。

  • リクエスト制限について
  • 24時間で最大5,000リクエスト以内となっております。

  • リクエストURL
  • https://api.jancodelookup.com/

    ※リクエスト例
    https://api.jancodelookup.com/?appId=[アプリID]&query=[キーワード]&hits=[取得件数]&page=[取得ページ]&type=[検索タイプ]

  • 入力パラメータ
  • ID 項目名 パラメーター 必須 デフォルト 備考
    1 アプリID appId - こちらから取得してください。
    2 検索キーワード query - UTF-8でURLエンコードした文字列
    3 取得件数 hits - 30 1度に取得する件数、1以上の整数
    4 取得ページ page - 1 取得ページ指定、1以上の整数
    5 検索タイプ type - keyword keyword: 通常検索
    code: コード番号限定(前方一致)
    ※最低7桁以上、それ以下は無視されます。
  • 出力パラメータ
  • 全体情報 - info
    ID 項目名 パラメーター 備考
    1 検索数 count 検索結果の総商品数
    2 ページ番号 page 現在のページ番号
    3 ページ内商品始追番 first 検索結果の何件目からか
    4 ページ内結果終了番号 last 検索結果の何件目までか
    5 ヒット件数番 hits 返却した商品数
    6 総ページ数 pageCount キーワードに対して返却可能な総ページ数
    商品情報 - product
    ID 項目名 パラメーター 備考
    1 コード番号 codeNumber 13桁のコード番号
    2 コードタイプ codeType JAN/EAN/ISBN/UPC
    3 商品名 itemName
    4 品番(型番) itemModel
    5 詳細ページURL itemUrl https://www.jancodelookup.com/code/[codeNumber]/
    6 商品画像URL itemImageUrl https://image.jancodelookup.com/[codeNumber].jpg
    7 ブランド名 brandName
    8 会社名 makerName
    9 会社名(カナ) makerNameKana 全角カタカナ
    10 商品追加情報 ProductDetails 内容量や原材料名など、商品に関連する追加情報
  • よくある質問
    • 利用料金はかかりますか?
    • 24時間あたり5,000リクエストまで無料でご利用いただくことができます。

    • リクエスト制限の緩和はできますか?
    • リクエスト制限の緩和は現在のところ受け付けておりません。制限値内でご利用ください。

    • 文字コードは何ですか?
    • UTF-8となります。

    • 法人でも利用できますか?
    • 個人法人問わず、アプリIDを発行していただければご利用可能です。

    • 取得したデータを保存して使ってもいいですか?
    • データを保存してご利用いただいて構いません。

    • 実装がうまくいかないので、サポートをしてほしい
    • 有償となりますが、対応いたします。お気軽にご相談ください。

    • アプリの利用を停止したい
    • アプリ発行画面よりいつでも利用停止が可能です。