Akeneo Event Platform

Complete reference on how to handle Akeneo Event Platform Subsrcibers and Subsriptions

Subscriber

Create a Subscribing service

REQUEST

post /api/v1/subscriber

Path parameters

Ø

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscribing service created

Body Format application/json

Ø

Bad request - the request payload was malformatted

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Maximum number of subscribers reached

Body Format application/json

Ø

Get all subscribers

Get all subscribers that are either active or revoked

REQUEST

get /api/v1/subscriber

Path parameters

Ø

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

List of subscribers

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Get a subscriber

Get a subscriber configuration with its identifier

REQUEST

get /api/v1/subscriber/{subscriber_id}

Path parameters

subscriber_id () • Subscriber id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscriber found

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Subscriber not found

Body Format application/json

Ø

Update a Subscribing service

REQUEST

patch /api/v1/subscriber/{subscriber_id}

Path parameters

subscriber_id () • Subscriber id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscriber updated

Body Format application/json

Ø

Bad request - the request payload was malformatted

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Delete a Subscribing service

REQUEST

delete /api/v1/subscriber/{subscriber_id}

Path parameters

subscriber_id () • Subscriber id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscriber deleted

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Subscriber not found

Body Format application/json

Ø

Subscription

Create a subscription

Create a subscription with a configuration of a destination and the list of events the destination wants to receive

REQUEST

post /api/v1/subscriber/{subscriber_id}/subscription

Path parameters

subscriber_id () • Subscriber id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscription created

Body Format application/json

Ø

Bad request - the request payload was malformatted

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Not allowed

Body Format application/json

Ø

Subscriber not found

Body Format application/json

Ø

Maximum number of subscriptions reached

Body Format application/json

Ø

Retrieve the list of all subscriptions for this app

REQUEST

get /api/v1/subscriber/{subscriber_id}/subscription

Path parameters

subscriber_id () • Subscriber id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscriptions successfully retrieved

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Not allowed

Body Format application/json

Ø

subscriber not found

Body Format application/json

Ø

Retrieve a subscription configuration

REQUEST

get /api/v1/subscriber/{subscriber_id}/subscription/{id}

Path parameters

subscriber_id () • Subscriber id

id () • Subscription id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscription found

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Not allowed

Body Format application/json

Ø

subscriber not found

Body Format application/json

Ø

Update a subscription configuration

REQUEST

patch /api/v1/subscriber/{subscriber_id}/subscription/{id}

Path parameters

subscriber_id () • Subscriber id

id () • Subscription id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscription updated

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Not allowed

Body Format application/json

Ø

Subscriber or subscription not found

Body Format application/json

Ø

Delete a subscription

REQUEST

delete /api/v1/subscriber/{subscriber_id}/subscription/{id}

Path parameters

subscriber_id () • Subscriber id

id () • Subscription id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Subscribtion deleted

Body Format application/json

Ø

Proactively suspend a subscription

REQUEST

post /api/v1/subscriber/{subscriber_id}/subscription/{id}/suspend

Path parameters

subscriber_id () • Subscriber id

id () • Subscription id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Acknowledge subscription suspension (async operation)

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Not allowed

Body Format application/json

Ø

Subscriber or subscription not found

Body Format application/json

Ø

Subscribtion is deleted

Body Format application/json

Ø

Proactively resume a suspended subscription

REQUEST

post /api/v1/subscriber/{subscriber_id}/subscription/{id}/resume

Path parameters

subscriber_id () • Subscriber id

id () • Subscription id

Query parameters

Ø

Headers

Authorization • Equal to 'Bearer xxx', `xxx` being the authentication token, see Authentication section

Accept • Equal to 'application/json', no other value allowed

Body

Ø

RESPONSES

Acknowledge subscription resumption (async operation)

Body Format application/json

Ø

Unauthorized - tenant context not found or invalid credentials

Body Format application/json

Ø

Not allowed

Body Format application/json

Ø

Subscriber or subscription not found

Body Format application/json

Ø

Subscribtion is deleted

Body Format application/json

Ø