L’abonnement au numéro de compte de visibilité intégrée avancée est conçu pour permettre aux abonnés à visibilité intégrée avancée de gérer leurs projets basés sur des numéros de compte et d’effectuer des opérations liées aux projets, telles que la modification ou la consultation des détails, au moyen des points de terminaison d’API.

Note :

• Vous devez disposer d’un accès administrateur pour votre projet API dans lequel cette API est activée.
• Pour en savoir plus sur la visibilité intégrée avancée et ses fonctionnalités, consultez la page de la documentation de la visibilité intégrée avancée.

Les avantages de l’abonnement au numéro de compte de visibilité intégrée avancée sont :

• Vous pouvez facilement mettre à jour et gérer votre projet visibilité intégrée avancée en utilisant les points de terminaison de l’API.
• Cette API vous permet d’associer plusieurs comptes à votre projet en une seule transaction d’API, au lieu de sélectionner chaque compte un par un.

Utilisez les points de terminaison ci-dessous pour gérer votre projet Visibilité intégrée avancée :

Mise à jour du projet de visibilité intégrée avancée

Utilisez ce point de terminaison pour mettre à jour les détails de tout projet de visibilité intégrée avancée au sein de votre organisation.

Les renseignements pour cette demande sont les suivants :

• requestType : Spécifiez le type de demande de mise à jour. 
  • AJOUTER_DES_COMPTES : utilisez cette option pour ajouter de nouveaux comptes dans le projet existant si l’organisation est déjà associée à un projet de visibilité intégrée avancée pour tous les comptes.
  • DELETE_ACCOUNTS : Utilisez cette option pour supprimer n’importe quel compte du projet.
  • UPDATE_ALL : Utilisez cette option pour des mises à jour régulières du projet.
Remarque : Cet élément est facultatif et UPDATE_ALL est sélectionné par défaut, s’il n’est pas spécifié par l’utilisateur.
• category : Spécifiez la catégorie de la fonction que vous souhaitez mettre à jour pour le projet. Par exemple : RETRY_POLICY, PROOF_OF_DELIVERY etc.
• subCategories : Spécifiez les fonctions individuelles pour la catégorie de fonctions sélectionnée. Par exemple : BASIC_HRS, PPOD, SPOD, SHIP, TRAN etc.

Une réponse positive à cette demande renverra l’identifiant de l’abonnement, un indicateur précisant si le projet a été mis à jour pour tous les comptes de l’organisation, et un horodatage du projet mis à jour.

Récupérer les détails du projet

Utilisez ce point de terminaison pour récupérer les détails d’un projet de visibilité intégrée avancée spécifié sous forme paginée.

Les renseignements requis pour cette demande sont les suivants :

• authorization : Spécifiez le jeton d’autorisation.
• subscriptionId : indiquez l’identifiant de l’abonnement au projet de visibilité intégrée avancée pour récupérer les détails.

Une réponse positive à cette demande génère les détails du projet de webhook spécifié dans un format paginé, ou renvoie une alerte ou des détails d’erreur en cas d’échec.

• Un maximum de 30 000 numéros de compte d’expédition peut être associé à un projet de visibilité intégrée avancée dans une même requête.