Automation Products API

Authentication

Every request must include your public API key and private API secret in the HTTP headers.

X-API-KEY: your_public_api_key
X-API-SECRET: your_private_api_secret

Available Endpoints

How Product Code Search Works

Product codes are searched using both the original value and a normalized version of the code.

During normalization, the API:

• converts codes to uppercase
• removes spaces
• removes hyphens - and full-width hyphens －
• removes dots .
• removes slashes /
• removes plus signs +
• removes underscores _
• removes parentheses ( ) and full-width parentheses （ ）
• removes pipes | and full-width pipes ｜
• removes asterisks * and full-width asterisks ＊
• removes colons : and full-width colons ：
• removes commas , and full-width commas ，
• removes semicolons ; and full-width semicolons ；

Original input:
6ES7-131 4BF00/0AA0

Normalized search:
6ES71314BF000AA0

Brand Access

API access is restricted to the brands assigned to the authenticated API account.

If a request contains a brand that is not available for the API account, the API returns an authorization error.

{
  "success": false,
  "error": "Brand not available for this API account."
}

1. Brands Endpoint

GET /v1/brands.php

Returns the list of brands available for the authenticated API account. This endpoint can be used by an ERP system to retrieve the available brands, the number of searchable products for each brand, and the public brand URL.

The response includes the total number of returned brands through the total_brands field. Each brand also includes an available_products value, which represents the number of products currently indexed and available through the Automation Products search engine for that specific brand.

curl -X GET "https://api.automation-products.com/v1/brands.php" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET"

Response Example

{
  "success": true,
  "endpoint": "brands",
  "total_brands": 30,
  "brands": [
    {
      "brand": "AECO",
      "available_products": 2399,
      "url": "https://automation-products.com/brand/aeco/"
    },
    {
      "brand": "AVENTICS",
      "available_products": 0,
      "url": "https://automation-products.com/brand/aventics/"
    },
    {
      "brand": "BALLUFF",
      "available_products": 17599,
      "url": "https://automation-products.com/brand/balluff/"
    },
    {
      "brand": "SIEMENS",
      "available_products": 40243,
      "url": "https://automation-products.com/brand/siemens/"
    }
  ]
}

Response Fields

2. Product Detail Endpoint

GET /v1/product.php?code=ACC000001

Returns detailed information for a single product code.

curl -X GET "https://api.automation-products.com/v1/product.php?code=ACC000001" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET"

3. Search Endpoint

GET /v1/search.php?code=ACC000001

Flexible search endpoint designed for user-facing searches and alternative product matching.

curl -X GET "https://api.automation-products.com/v1/search.php?code=ACC000001" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET"

Optional Brand Filter

The search endpoint supports an optional brand name filter. When provided, the API searches only within that brand, provided that the brand is available for the authenticated API account.

curl -X GET "https://api.automation-products.com/v1/search.php?code=ACC000001&brand=AECO" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET"

Multiple Search Request

curl -X POST "https://api.automation-products.com/v1/search.php" \
-H "Content-Type: application/json" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET" \
-d '{
  "codes": [
    "ACC000001",
    "ACC-000001",
    "ACC_000001",
    "6ES7-131 4BF00/0AA0"
  ]
}'

Multiple Search Request with Brand Filter

curl -X POST "https://api.automation-products.com/v1/search.php" \
-H "Content-Type: application/json" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET" \
-d '{
  "brand": "AECO",
  "codes": [
    "ACC000001",
    "ACC-000001",
    "ACC_000001"
  ]
}'

4. Batch Endpoint

POST /v1/batch.php

The batch endpoint is designed for ERP synchronization and bulk product verification.

Multiple product codes can be submitted in one single request using the codes JSON array.

{
  "codes": [
    "ACC000001",
    "ACC-000001",
    "ACC_000001",
    "6ES7-131 4BF00/0AA0"
  ]
}

Each submitted code is processed independently. A successful batch response may contain both found and not found products.

Maximum batch size: 100 codes per request.

curl -X POST "https://api.automation-products.com/v1/batch.php" \
-H "Content-Type: application/json" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "X-API-SECRET: YOUR_API_SECRET" \
-d '{
  "codes": [
    "ACC000001",
    "ACC-000001",
    "ACC_000001",
    "6ES7-131 4BF00/0AA0"
  ]
}'

Commercial Availability Logic

Search vs Product vs Batch

Security & Limits

• All requests require authentication
• All requests are logged
• Batch requests are limited to 100 codes
• Commercial and internal configuration data are protected
• Rate limiting may apply

Error Responses

{
  "success": false,
  "error": "Missing API credentials."
}

{
  "success": false,
  "error": "Invalid API key or inactive API."
}

{
  "success": false,
  "error": "Invalid API secret."
}

{
  "success": false,
  "error": "Brand not available for this API account."
}

{
  "success": false,
  "error": "Product not found. Please request a quotation."
}