bar-code-query
商品バーコード検索
商品のバーコード(EAN-13など)を入力すると、商品名、ブランド、参考価格、メーカーなどの詳細情報を素早く照会できます。小売業、在庫管理、その他のシナリオに適しています。
利用料金
10 コイン/回
クイックスタート
統一レスポンス形式のまま、バックエンドから直接呼び出せます。
https://openapi.toolkk.com/v1/bar-code-querycURL 例
curl --request POST \
--url 'https://openapi.toolkk.com/v1/bar-code-query' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "barcode": "6901028089296"\n}'Python 例
import os
import requests
url = "https://openapi.toolkk.com/v1/bar-code-query"
payload = {
"barcode": "6901028089296"
}
headers = {
"Content-Type": "application/json",
"X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"),
}
response = requests.request("POST", url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())Go 例
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
endpoint := "https://openapi.toolkk.com/v1/bar-code-query"
payload := []byte("{\n \"barcode\": \"6901028089296\"\n}")
req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}Java 例
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ToolkkExample {
public static void main(String[] args) throws Exception {
String payload = "{\n \"barcode\": \"6901028089296\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/bar-code-query"))
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.header("Content-Type", "application/json")
.header("X-API-Key", "YOUR_API_KEY")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}PHP 例
<?php
$endpoint = 'https://openapi.toolkk.com/v1/bar-code-query';
$payload = "{\n \"barcode\": \"6901028089296\"\n}";
$ch = curl_init($endpoint);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-API-Key: YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;レスポンス例
{
"code": "SUCCESS",
"message": "success",
"data": {
"name": "中华(软)香烟",
"brand": "中华",
"price": "65.00",
"manufacturer": "上海烟草集团有限责任公司"
}
}例はレスポンスの構造を示しています。実際の結果はAPIの応答によって異なります。
- 認証方式
- リクエストヘッダーに X-API-Key を設定
- レート制限
- 毎分 600 回
- タイムアウト
- 5000 ms
サーバー側から呼び出す際は、X-API-Key ヘッダーに API Key を設定します。
HTTP ステータスと業務フィールドの両方で成功判定するのがおすすめです。
高頻度利用ではレート制限と再試行戦略を併用してください。
リクエスト項目
サーバーからリクエストを送信し、X-API-Keyヘッダーにキーを設定してください。
リクエスト項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | 必須 | 説明 | サンプル値 |
|---|---|---|---|---|
| barcode | string | 未指定 | 未指定 | 6901028089296 |
リクエスト例
{
"barcode": "6901028089296"
}- 認証方式
- リクエストヘッダーに X-API-Key を設定
- レート制限
- 毎分 600 回
- タイムアウト
- 5000 ms
レスポンス項目
例はレスポンスの構造を示しています。実際の結果はAPIの応答によって異なります。
レスポンス項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | 必須 | 説明 | サンプル値 |
|---|---|---|---|---|
| code | string | 未指定 | 未指定 | SUCCESS |
| message | string | 未指定 | 未指定 | success |
| data | object | 未指定 | 未指定 | {...} |
| data.name | string | 未指定 | 未指定 | 中华(软)香烟 |
| data.brand | string | 未指定 | 未指定 | 中华 |
| data.price | string | 未指定 | 未指定 | 65.00 |
| data.manufacturer | string | 未指定 | 未指定 | 上海烟草集团有限责任公司 |
レスポンス例
{
"code": "SUCCESS",
"message": "success",
"data": {
"name": "中华(软)香烟",
"brand": "中华",
"price": "65.00",
"manufacturer": "上海烟草集团有限责任公司"
}
}$.code == 200 || $.code == 201APIの概要
機能、利用シーン、制約、よくある質問。
インターフェース機能
製品バーコード クエリ API を使用すると、開発者は標準製品バーコード (一般的な 13 桁の EAN-13 コードなど) を入力することで、対応する基本的な製品情報を取得できます。返されるデータには通常、製品名、ブランド、参考価格、製造元などが含まれます。このインターフェイスは、開発者が製品情報データベースを迅速に確立し、手動入力コストを削減するのに役立ちます。
リクエストと返却
- リクエストパラメータ:
barcode(製品バーコード) のみが必要です。受信バーコードが純粋な数値文字列であることを確認してください。 - 結果を返す: インターフェイスは、製品情報を含む JSON オブジェクトを返します。主要なフィールドには、名前、ブランド、価格、製造元が含まれます。
- 障害のトラブルシューティング: 製品が見つからない場合は、バーコードが正しく入力されているかどうか、または製品に非標準バーコードまたは社内流通コードが付いているかどうかを確認してください。
使用シナリオ
- 小売レジおよび QR コード スキャン: POS マシンまたはモバイル アプリケーションでバーコードをスキャンして、製品情報をすばやく識別して表示します。
- 在庫と倉庫管理: 入庫時にQRコードをスキャンすることで商品詳細を自動的に取得し、入庫効率を向上させます。
- 電子商取引および価格比較ツール: ユーザーは QR コードをスキャンして基本的な製品情報を表示し、価格比較や製品のトレーサビリティに役立ちます。
指示と制限事項
- このインターフェースによって返される商品価格は参考のみであり、現在の市場における実際の取引価格を表すものではありません。