Evolution produit : Annonce du retrait de la version V0 de l’API TRIGGERS AND ACTION

La version V0 de l’API Triggers and Action est dépréciée depuis le 30/06/2019 et a été remplacée par une nouvelle version (version V1) .
La version V0 de l’API Triggers and Action sera retirée le 31/07/2022.

Ce qu’il faut savoir sur les changements

La différence entre la version 0 et la version 1 de l’API Triggers and Action se concentre sur la section Trigger. Cette section en Version 1 est dorénavant plus claire et permet d’exprimer des règles de routage avec un scope beaucoup plus large. Pour en savoir plus et mieux comprendre, nous recommandons vivement de lire le manuel utilisateur section 13.2 Triggers

Point d’attention

Toutes les règles que vous avez créées à partir de la version V0 de l’API Triggers and action sont encore disponibles et continueront à être disponibles après le 31/07/2022.
La seule différence est que vous devrez les appeler en utilisant la version V1 des endpoints.

Astuce

Comprendre le nouveau format de la section Trigger

Toutes les règles déjà existantes sont disponibles via la version V1 de l’API triggers and actions.
Par conséquent il peut être utile d’appeler ces règles existantes avec les endpoints GET de la version V0 et de la version V1 : il sera ainsi plus aisé d’identifier et de comprendre comment la section trigger de la nouvelle version V1 trigger section est mise en forme, en regard de la version V0.

Une autre possibilité est d’utiliser le portail web pour créer des règles simples avec les outils disponibles, et d’ensuite inspecter la façon dont le body json aura été créé

Plus de détails sur chacun des endpoints ci-dessous :

Endpoint :
DELETE /api/v0/event2action/actionPolicies/{policyId}

Nouveau endpoint :

DELETE /api/v1/event2action/actionPolicies/{policyId}

Un simple changement de path, l’appel est quant à lui identique à la version précédente

Endpoint :
GET /api/v0/event2action/actionPolicies/{policyId}

Nouveau endpoint :

GET /api/v1/event2action/actionPolicies/{policyId}

Pour l’appel seul le path change
La réponse est formattée en version V1, mais toute règle créée précédemment en version V0 est disponible, quoique le format retourné sera le format version V1

Endpoint :
GET /api/v0/event2action/actionPolicies/

Nouveau endpoint :

GET /api/v1/event2action/actionPolicies/

Pour l’appel seul le path change
La réponse est formattée en version V1, mais toutes les règles créées précédemment en version V0 sont disponibles, quoique le format retourné sera le format version V1

Endpoint :
POST /api/v0/event2action/actionPolicies/

Nouveau endpoint :

POST /api/v1/event2action/actionPolicies/

L’appel nécessite d’utiliser la sémantique en version V1 dans la section trigger, qui est détaillée et expliquée dans le manuel utilisateur section 13.2 Triggers. Une autre source d’information utile est le swagger qui fournit un exemple.

Endpoint :
PUT /api/v0/event2action/actionPolicies/{policyId}

Nouveau endpoint

 PUT /api/v1/event2action/actionPolicies/{policyId}

L’appel nécessite d’utiliser la sémantique en version V1 dans la section trigger, qui est détaillée et expliquée dans le manuel utilisateur section 13.2 Triggers. Une autre source d’information utile est le swagger qui fournit un exemple.

Rappel ci-dessous des principaux points d’accès à la documentation

Swagger: https://liveobjects.orange-business.com/#/cms/documentation-swagger/

Guide Développeur : https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html