Download the PHP package trilix/akeneo-events-api-bundle without Composer

On this page you can find all versions of the php package trilix/akeneo-events-api-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of trilix/akeneo-events-api-bundle

Informations about the package akeneo-events-api-bundle

Akeneo PIM Events API

The Events API is a smooth and easy way to build integrations that respond to activities in Akeneo PIM. All you need is PIM Events API Bundle and an endpoint where to send Akeneo PIM events.

Table of contents

Getting Started

Requirements

Installation

Install via composer:

To enable the bundle add to the config/bundles.php file:

Add the following line at the end of env file:

where your_request_url is a target location where all the events (see event types) will be delivered.

Create file config/packages/trilix_events_api.yml with the following:

Clear cache:

Run the following command to create a job to deliver events to consumer:

Make sure Akeneo job queue daemon is running. For more information read Setting up the job queue daemon.

Functionality

How it works

Some event(s) happens in Akeneo PIM. This triggers a mechanism to send those event(s) as HTTP POST request to your Request URL. Each request contains event, with correspondent example).

Events API sends one request per one event, and sending of requests happens in real-time.

Event types delivered over Events API

Event Description
category_created New category was created
category_updated Existing category was updated
category_removed Existing category was deleted
attribute_created New attribute was created
attribute_updated Existing attribute was updated
attribute_removed Existing attribute was deleted
family_created New family was created
family_updated Existing family was updated
family_removed Existing family was deleted
product_created New product was created
product_updated Existing product was updated
product_removed Existing product was deleted
product_model_created New product model was created
product_model_updated Existing product model was updated
product_model_removed Existing product model was deleted

Example of category_updated event

Example of product_model_removed event

Event Type Structure

Field Type Description
event_type String Type of event which happened (see event types)
payload Object Contains information which represents the event. For events related to deletion of entity it contains entity only identifier (identifier value for Products and code for all others)
event_time Integer Timestamp in seconds when the event was created

Attention :heavy_exclamation_mark:

If Akeneo family contains variants, then during family update (or it's variants as well), Akeneo will re-save related products. It will trigger sending product_updated events.

License

This project is licensed under the MIT License - see the LICENSE file for details

All versions of akeneo-events-api-bundle with dependencies

PHP Build Version
Package Version
Requires akeneo/pim-community-dev Version ^5.0
beberlei/assert Version ^3.3
psr/http-client Version ^1
guzzlehttp/guzzle Version ~6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package trilix/akeneo-events-api-bundle contains the following files

Loading the files please wait ....