Avertissement

Il s’agit de l'ancien API de synchronisation différentielle (qui utilise un POST).

S’il est toujours possible de l’utiliser, nous encourageons les usagers à privilégier le nouvel API, présenté ici : 1.2 Synchronisation différentielle


1. Création des fichiers de mise à jour

2. Récupération des fichiers ONIX


Cet API permet de recevoir les métadonnées complètes des publications modifiées depuis la dernière synchronisation complète ou différentielle. Il sert à effectuer des mises à jour régulières.

Si le nombre de modifications apportées aux publications est trop grand (code HTTP 400), il faut utiliser l’API de synchronisation complète du catalogue.


Étapes :

  1. Appel de l'API Création des fichiers de mise à jour (1); réception de la liste des URL des fichiers ONIX;

  2. Pour chaque URL de la liste, appeler l'URL pour télécharger le fichier (2) et le traiter.


1. Création des fichiers de mise à jour

Cet API crée sur la plateforme Cantook les fichiers ONIX qui servent ensuite à mettre à jour le catalogue des vendeurs.


Déclaration

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

Formats : xml, onix

Méthode : POST

Sécurité : HTTP/BASIC (Nom d'utilisateur et mot de passe)


Paramètres

organisation_id (Obligatoire)

Numéro d'organisation. Fourni à l'inscription.


reset_at (Optionnel)

Date/heure. Format ISO 8601 Basic. Présent : Retourne tous les changements ayant eu lieu après cette date/heure. Si absent : Retourne les changements ayant eu lieu depuis le dernier appel.


Format (Optionnel)

xml, onix - La valeur par défaut est “xml”.


Réponses

200 : OK

La liste a été créée avec succès. Le corps de la réponse contiendra un vecteur d'URL. Voir la description à la section 2. Un vecteur vide indique qu'il n'y a pas eu de changements depuis la dernière synchronisation.


400 : too_many_results

Le nombre de modifications est trop important. Utiliser plutôt l’API de synchronisation complète du catalogue.


401 : access_denied

Accès refusé à la ressource.


404 : not_found

L'organisation n'a pu être trouvée ou l'URL a été appelé avec la méthode HTTP GET plutôt que POST.


415 : invalid_format

Le format demandé n'est pas supporté.


415 : invalid_date

La date spécifiée dans reset_at est incorrecte.


2. Récupération des fichiers ONIX

Les URL pour la récupération des fichiers ONIX sont fournis en réponse à l'API Création des fichiers de mise à jour (voir section 1 ci-haut). Vous n'aurez jamais à générer ces adresses.


Voici la description détaillée de l'appel à ces URL.

Déclaration

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

Formats : xml, onix

Méthode : GET

Sécurité : HTTP/BASIC (Nom d'utilisateur et mot de passe)


Paramètres

organisation_id (Obligatoire)

Numéro d'organisation. Fourni à l'inscription.


list_id (Obligatoire)

Identifiant de la liste.


Réponses

200 : OK

Le métadonnées des publications dans le format demandé (ONIX ou XML).


401 : access_denied

Accès refusé à la ressource.


404 : not_found

L'organisation n'a pu être trouvée.