Weave Code
Laravel Akeneo Client Laravel Package
justbetter/laravel-akeneo-client
A Laravel-friendly wrapper around Akeneo’s PHP API client, offering configuration, service container bindings, and convenient access to PIM products, categories, families, and other resources from your application.
A Laravel package for the Akeneo API
Frequently asked questions about Laravel Akeneo Client
- How do I install justbetter/laravel-akeneo-client in a Laravel app?
- Install it with Composer using composer require justbetter/laravel-akeneo-client, then publish the package configuration with Laravel's vendor:publish command. Populate the Akeneo API credentials in your environment file and resolve the client from the service container or facade. Because 1.6.1 fixed request URL construction, pin that exact version until you have smoke tests for the endpoints you use.
- Which Laravel and PHP versions does this Akeneo client support?
- The package follows standard Laravel package conventions, but you should confirm the exact Laravel and PHP version matrix in its composer.json and CI configuration before adopting it. A package at 1.6.x with a small maintainer base may lag the newest Laravel major release, and that gap becomes your constraint at the next framework upgrade. Test against your target stack rather than assuming broad compatibility.
- Does this package synchronize products between Laravel and Akeneo?
- No. It is a thin integration transport layer that provides authenticated access to Akeneo PIM endpoints such as products, families, attributes, categories, and media. Product-model mapping, delta detection, conflict resolution, and catalog publishing logic remain your responsibility in your own jobs and services. Wrap the client behind your own repository or gateway interface so domain sync code is not coupled to its method signatures.
- How do I configure Akeneo API credentials in Laravel?
- Publish the package config and set the Akeneo base URL and authentication values through environment variables rather than hardcoding them. The exact credential fields depend on your Akeneo edition and auth model, so verify them against the package config and Akeneo's API client documentation. Then resolve the configured client from Laravel's container and inject it where needed.
- Does the client handle Akeneo OAuth token acquisition and refresh?
- The wrapper delegates authentication to Akeneo's underlying PHP API client, so token acquisition, caching, storage, and refresh behavior follow that client and your configuration. Confirm where tokens are cached and how refresh is handled before relying on it in long-running queue workers. If token lifecycle is critical, test expiry and refresh scenarios explicitly.
- Does this Laravel Akeneo client support pagination for product searches?
- Several Akeneo endpoints use cursor-style pagination such as search_after and limit parameters, and this wrapper generally exposes the underlying client rather than adding a high-level iterator. In most cases your application code is responsible for looping through pages and persisting cursors. Check the client methods you plan to use and add pagination tests for large catalogs.
- What does the Akeneo client return: arrays, DTOs, or raw responses?
- Return types follow Akeneo's PHP API client rather than a separate typed DTO layer added by this package. Expect resource objects or arrays depending on the endpoint and client method, and confirm the exact contract in the upstream client documentation. If your application needs stable domain objects, map the responses inside your own gateway layer.
- Is justbetter/laravel-akeneo-client 1.6.1 safe for production use?
- Version 1.6.1 is a non-breaking single-line patch that fixes request URL construction, so pin it exactly rather than using a floating constraint. The fact that a URL-building defect shipped suggests that path has been thinly exercised by tests, and URL assembly affects every outbound call. Add smoke tests against the specific Akeneo endpoints you depend on before relying on it in production.
- How should I handle Akeneo API rate limits and 429 responses?
- Treat this package as transport only and implement retry and backoff behavior in your own Laravel jobs or HTTP layer. Akeneo can return 429 responses and transient 5xx errors, so respect Retry-After headers and avoid tight retry loops. Confirm whether the underlying Akeneo PHP client surfaces these responses raw or applies any retry logic.
- What are alternatives to justbetter/laravel-akeneo-client for Laravel?
- You can use Akeneo's PHP API client directly and wire it into Laravel yourself, or build a small wrapper around Laravel's HTTP client and Guzzle. This package mainly saves time by providing configuration, service container bindings, and conventional Laravel setup. Keep your integration behind a vendor-neutral interface so swapping to a hand-rolled client remains a contained change.
Weaver
How can I help you explore Laravel packages today?