akeneo_api_client library
Akeneo API Client library for interacting with the Akeneo PIM REST API.
This library provides classes and utilities for making API requests and handling responses using the Akeneo PIM API.
Example usage:
import 'package:akeneo_api_client/akeneo_api_client.dart';
void main() async {
final client = AkeneoClient(
endpoint: Uri.parse('https://akeneo-endpoint.com'),
clientId: 'client-id',
clientSecret: 'client-secret',
userName: 'username',
password: 'password',
);
final products = await client.getProducts();
print(products);
}
For more information, see the Akeneo PIM API documentation.
Classes
- AkeneoApiClient
- A Dart client for interacting with the Akeneo API.
- AkeneoPaginatedResponse
- Represents a paginated response from the Akeneo API.
- ApiError
- Represents an API error in Akeneo. This class contains information about the property, message, attribute, a list of ApiErrors is returned in an error response
- Attribute
- Represents an attribute in Akeneo.
- AttributeGroup
- Represents an attribute group in Akeneo.
- AttributeOption
- Category
- Channel
- Embedded
- Represents embedded items within a paginated response.
- ErrorResponse
- Represents an error response returned from the API.
- Family
- FamilyVariant
- Product
- ProductModel
- QueryParameter
- Represents query parameters for customizing data retrieval from Akeneo.
- SearchFilter
- Represents a search filter used in querying Akeneo data.
- Value
- Represents a value in Akeneo.
- VariantAttributeSet
Enums
- AkeneoOperator
- Enumeration of operators used in Akeneo search filters.
- AttributeType
- Enumeration of attribute types used in Akeneo.
Extensions
- AkeneoOperatorValue on AkeneoOperator
-
Extension for the
AkeneoOperator
enum providing a string representation for JSON serialization. - AttributeTypeValue on AttributeType
-
Extension for the
AttributeType
enum providing a string representation for JSON serialization.
Exceptions / Errors
- ApiException
- Exception class representing errors that occur during API interactions.