Download the PHP package macropage/idealo-business-api without Composer
On this page you can find all versions of the php package macropage/idealo-business-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download macropage/idealo-business-api
More information about macropage/idealo-business-api
Files in macropage/idealo-business-api
Package idealo-business-api
Short Description idealo Business Click API SDK based on Saloon PHP
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package idealo-business-api
idealo Business Click API SDK
PHP SDK for the idealo Business Click Report API, built on Saloon PHP.
Implements the V2 Detailed Click Report flow only. The deprecated V1 Detailed Click Report (planned shutdown 2026-03-15) is intentionally not included.
Requirements
- PHP
^8.2 saloonphp/saloon^4.0- A pair of idealo Business API credentials (
client_id+client_secret)
Installation
Quick Start
The SDK reads no env vars itself. Wire your own config:
Auth
- Endpoint:
POST /api/v1/oauth/token - Auth: HTTP Basic (
client_id:client_secret) - No request body
- Response fields used by the SDK:
access_token,expires_in,scope,shop_id
The connector caches the token internally. boot() re-authenticates automatically when the token has expired (with a 60-second safety buffer).
Detailed Click Report V2 Flow
The full flow is start → poll → download.
1. Start a report
HTTP 201 Created on success. endTime is not present while status is PROCESSING.
2. Poll status
Poll responsibly. The SDK ships no built-in polling helper on purpose, so you stay in control of intervals and retries.
3. Download (when SUCCESSFUL)
The download response is a ZIP archive containing one CSV file. The SDK does not decompress or parse it.
Server filename pattern: click-cost-report_{shopId}_{YYYY-MM-DD-HH-MM-SS}.csv.zip.
Inspect with PHP's ZipArchive:
CSV Columns (Detailed V2)
In order:
Customer-IPis hashed.EANsmay contain one or more GTIN values.Cpcis the cost per click (decimal).Click Typedistinguishes regularofferclicks from low-price-inventory clicks. See the official docs for the full list.
Limits and Date Rules
- 5 requests per 24 hours to
start()per shop. - At least 15 minutes between two
start()calls. - The report covers data up to 15 months in the past, but never including today.
- Previous-day data is typically available from ~05:00 UTC.
- Exceeding the limits returns HTTP 429.
Error Handling
The connector uses AlwaysThrowOnErrors. Non-2xx responses throw Saloon\Exceptions\Request\RequestException. Common ones:
| Status | Meaning |
|---|---|
409 Conflict |
A report is already in progress for this shop. |
429 Too Many Requests |
Rate limit reached (5/24h or 15-min minimum). |
Connector API
Deprecated and Out of Scope
- Detailed Click Report V1 (
/api/v1/shops/{shopId}/click-reports) — discontinued 2026-03-15, not implemented. - Daily Click Report — exists at
/api/v1/shops/{shopId}/daily-click-reports/downloadand is not yet covered by this SDK. - The SDK does not decompress ZIPs, parse CSV, validate dates, or poll automatically. Those are application concerns.
