Warning

This is the former API of differential synchronization (which uses the POST method).

If it is still possible to use the former API, we encourage all of our users to give priority to the new API presented here: 1.2 Differential synchronization


1. Update Files Creation

2. ONIX File Retrieval


This API is used to retrieve the complete metadata of the publications modified since the last synchronization (full or differential) or a specified date. It is used to get regular updates.

If the number of changes to the publication is too great (HTTP 400 code), you need to use the full synchronization API.


Steps:

  1. Call the Update Files Creation API (1);

  2. For each URL in the list, retrieve the file then process it (2).


[BACK]

1. Update Files Creation

This API creates ONIX files and returns a list of URLs for you to update your catalog with the publication's metadata. Only added, modified or cancelled publications that you have access to will be shown.


Declaration

Address : /api/organisations/[organisation_id]/publications/lists[.format]

Formats : xml, onix

Method : POST

Security : HTTP/BASIC (Use your username and password)


Parameters

organisation_id (Mandatory)

Your merchant number. This number is provided upon registration.


reset_at (Optional)

Date in ISO 8601 Basic format. Only used to retrieve list of changes made since a specific date. If this parameter is empty, the changes made since your last synchronization will be returned to you automatically.


format (Optional)

Possible values: onix / xml - Default value is "xml".


Responses

200 : OK

The list has been created successfully. The response body will contain a vector of web addresses (URL). See the description in section 2. An empty vector indicates that there was no changes since the last synchronization.


400 : too_many_results

The number of modifications is too great. Use the API for a full synchronization of the catalog.


401 : access_denied

You do not have access to the resource.


404 : not_found

Your organization could not be found. Note: You may also receive this answer if you're not using the appropriate HTTP method to make the call (GET vs POST)


415 : invalid_format

Requested format is invalid.


415 : invalid_date

Requested date is invalid.


[BACK]

2. ONIX File Retrieval

In response to API 1 (Update Files Creation), you will receive a URL list. Simply call these URLs to download the ONIX feed. You will never have to create these addresses. They will always be returned by the API 1 (Update Files Creation)..


Here is the detailed description of the format of these URLs, for reference only.

Declaration

Address : /api/organisations/[organisation_id]/publications/lists/[list_id].[xml|onix]

Formats : xml, onix

Method : GET

Security : HTTP/BASIC (Use your username and password)


Parameters

organisation_id (Mandatory)

Your merchant number. This number is provided upon registration.


list_id (Mandatory)

List identifier.


Responses

200 : OK

The metadata of the publications in onix or xml format.


401 : access_denied

You do not have access to the resource.


404 : not_found

Your organization could not be found.