Passer au contenu principal

Présentation de l’Open API d’Agorapulse

Quelles actions peut-on effectuer avec l’Open API ?

Avec l’Open API d’Agorapulse, vous pouvez intégrer vos données de reporting des réseaux sociaux à des systèmes externes, créer de nouvelles notes ou brouillons dans le calendrier et synchroniser les informations concernant les nouveaux éléments de la boîte de réception avec des outils externes. Cela permet d’améliorer la prise de décision et la visibilité, tout en gagnant du temps grâce à l’automatisation de la récupération des données.

Pour plus d’informations sur la création d’une clé API et sur la récupération de votre Organization ID, Workspace ID et de vos Profile UIDs, consultez cet article.

Dans cet article, nous aborderons les sujets suivants :

Remarque : L’Open API est disponible pour les utilisateurs disposant d’un abonnement Custom. Si vous souhaitez modifier votre abonnement pour accéder à cette fonctionnalité, n’hésitez pas à nous contacter ici.

Comment naviguer dans le document de référence de l’API

La navigation à gauche de la référence de l’API regroupe tous les endpoints dans les catégories suivantes :

  • Account & Workspaces : Organisations, Espaces de travail, Profils et Groupes

  • Publishing : Brouillons, Notes du calendrier et Tableaux Pinterest

  • Content Library : Médias

  • Inbox & Engagement : Conversations, Éléments et Réponses

  • Social Listening : Recherches, Métriques et Mentions

  • Analytics & Reporting : Rapports et Concurrents

Chaque page d’endpoint présente ses paramètres de chemin, ses paramètres de requête, le corps de la requête ainsi que des exemples de réponses. Vous pouvez utiliser Test Request pour envoyer une requête en temps réel à l’aide de la clé API renseignée dans le champ Value. Vous recevrez alors la réponse réelle de votre compte.

Pour utiliser la spécification avec vos propres outils, cliquez sur Download OpenAPI Document en haut de la page.

Qu’est-ce qui est disponible avec l’Open API ?

L’Open API peut être utilisée pour gérer la publication, les conversations de la boîte de réception des réseaux sociaux, la veille ainsi que les rapports. Dans les menus déroulants ci-dessous, nous détaillerons les actions qui peuvent être effectuées dans chaque section.

Publication

La section Publication de l’Open API vous permet de rechercher, créer, modifier et supprimer des notes du calendrier, ainsi que de récupérer la liste des tableaux disponibles sur un profil Pinterest.

Note de Calendrier

  • Rechercher des notes du calendrier : Recherchez et filtrez les notes du calendrier dans l’espace de travail spécifié.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

    • (Facultatif) Paramètres de requête

      • Since : Filtre les notes postérieures à cette date

      • Until : Filtre les notes antérieures à cette date
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • profileUids : Filtre par identifiants uniques de profil

  • Créer une nouvelle note du calendrier : Crée une nouvelle note du calendrier avec le contenu spécifié.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • Request Body (Données mises à jour de la note du calendrier)

      • Color (Couleur de la note du calendrier). Les couleurs disponibles sont :

        • BLUE

        • RED

        • YELLOW

        • GREEN

        • PURPLE

        • PINK

        • ORANGE

        • MINT

        • CYAN

        • GREY

      • endDate (Date de fin de la note)

      • startDate (Date de début de la note)
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • title (Titre de la note)

      • (Facultatif) body (Contenu de la note)

      • (Facultatif) profileUids (Liste des identifiants uniques de profil associés à la note)

  • Modifier une note du calendrier : Modifie une note du calendrier existante avec de nouvelles données.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • uid (Identifiant unique de la note du calendrier)

      • Body (Données mises à jour de la note du calendrier)

      • Color (Couleur de la note du calendrier). Les couleurs disponibles sont :

        • BLUE

        • RED

        • YELLOW

        • GREEN

        • PURPLE

        • PINK

        • ORANGE

        • MINT

        • CYAN

        • GREY

      • endDate (Date de fin de la note)

      • startDate (Date de début de la note)
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • title (Titre de la note)

      • (Facultatif) body (Contenu de la note)

      • (Facultatif) profileUids (Liste des identifiants uniques de profil associés à la note)

  • Supprimer une note du calendrier : Supprime une note du calendrier à l’aide de son UID.

    • Paramètres obligatoires :

      • organizationId (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • profileUid (Identifiant unique de la note du calendrier)

Tableaux Pinterest

  • Lister les tableaux d’un profil Pinterest : Répertorie les tableaux sur lesquels un profil Pinterest peut publier.

    • Paramètres obligatoires :

      • organizationId (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil Pinterest, tel qu’il est renvoyé par l’endpoint des profils)

Bibliothèque de contenu

La section Bibliothèque de contenu de l’Open API vous permet de créer un emplacement de téléchargement de médias afin de pouvoir importer des médias dans la Bibliothèque de contenu et consulter le statut d’un média importé.

Média

  • Créer un emplacement de téléchargement de média : Génère une URL de téléchargement pré-signée et enregistre un média en attente de téléchargement.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • Body (Média à créer)

      • fileName (Nom du fichier avec son extension, par exemple : clip.mp4)

  • Obtenir le statut d’un média : Renvoie le statut actuel du média et, une fois celui-ci analysé, ses métadonnées techniques.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • mediaUid (Identifiant du média)

Inbox & Engagement

La section Inbox & Engagement de l’Open API vous permet de récupérer les éléments de la boîte de réception et d’y répondre.

Conversations

  • Récupérer les messages d’une conversation : Consultez les fils de conversation depuis votre boîte de réception des réseaux sociaux.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil)

      • conversationId (Identifiant de la conversation)

    • (Facultatif) Paramètres de requête :

      • since : Filtre les messages postérieurs à cette date

      • until : Filtre les messages antérieurs à cette date
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • offset : Décalage utilisé pour la pagination

      • limit : Nombre maximal de messages à renvoyer par page. Doit être compris entre 1 et 25.

      • order : Ordre de tri des résultats. ASC pour un ordre croissant (du plus ancien au plus récent), DESC pour un ordre décroissant (du plus récent au plus ancien).

Éléments

  • Rechercher des éléments : Recherchez des éléments de la boîte de réception (commentaires, messages, avis).

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

    • (Facultatif) Paramètres de requête :

      • profilUids : Ensemble d’identifiants uniques de profils permettant de filtrer les éléments. Au moins un identifiant est requis. Seuls les éléments provenant de ces profils seront renvoyés.

      • toReview : Filtre les éléments nécessitant une validation (qui n’ont pas encore été approuvés par un responsable).

      • labels : Filtre les éléments par étiquette. Seuls les éléments associés à ces étiquettes seront renvoyés.

      • sentiments : Filtre les éléments par sentiment (positif, négatif, neutre).

      • types : Filtre les éléments par type. Indiquez les types d’éléments à récupérer :

        • ADS_COMMNENT

        • ORGANIC_COMMENT

        • MENTION

        • RATING

        • REEL_COMMENT

        • STORY_MENTION_CONVERSATION

        • PROFILE_COMMENT

        • PROFILE_MESSAGE

        • profileComment et profileMessage : Renvoient les réponses publiées par le profil lui-même. Toutes les autres valeurs renvoient les éléments entrants.

      • parentIds : Filtre les éléments par élément parent, en utilisant l’identifiant d’un élément renvoyé par cet endpoint. Renvoie les éléments enfants correspondants : les commentaires d’une publication, les réponses à un commentaire ou les messages d’une conversation.

      • since : Filtre les éléments postérieurs à cette date.

      • until : Filtre les éléments antérieurs à cette date.
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • offset : Décalage utilisé pour la pagination.

      • limit : Nombre maximal de messages à renvoyer par page. Doit être compris entre 1 et 25.

      • order : Ordre de tri des résultats. ASC pour un ordre croissant (du plus ancien au plus récent), DESC pour un ordre décroissant (du plus récent au plus ancien).

  • Récupérer un élément : Récupère un élément de la boîte de réception (commentaire, message ou avis).

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil)

      • itemID (Identifiant de l’élément, tel qu’il est renvoyé par l’endpoint des éléments)

Réponses

  • Répondre à un élément : Répond à un élément de la boîte de réception.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil)

      • Request Body (Requête permettant de créer une réponse à un élément de la boîte de réception)

      • itemId (Identifiant de l’élément de la boîte de réception auquel répondre)

      • message (Contenu du message de réponse)

      • (Facultatif) excludedUsers : Liste des identifiants des utilisateurs à exclure des mentions (spécifique à Twitter)

      • (Facultatif) privateReply : Lorsque cette option est définie sur true, envoie un message privé à l’utilisateur au lieu de répondre publiquement à un élément public (par exemple, un commentaire). La réponse est alors envoyée sous forme de message direct/privé. Disponible uniquement sur Facebook, Instagram et X (Twitter).

Veille

La section Veille de l’Open API vous permet de consulter la liste des recherches de veille actives, d’afficher les données des recherches actives (engagement, mots-clés, sentiment et volume) et de rechercher les éléments correspondant aux critères d’une recherche de Veille.

Recherches

  • Lister les recherches : Répertorie les recherches de veille d’un espace de travail, avec les réseaux sociaux qu'elles couvrent, leurs concurrents lorsqu’il s’agit de recherches concurrentielles, ainsi que leurs données pour les sept derniers jours.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

Données

  • Récupérer l’engagement d’une recherche : Calcule la somme des réactions, commentaires et partages générés par les éléments correspondant à une recherche de veille au cours de la période demandée, soit sous forme de totaux globaux, soit répartie selon une dimension. Les vues ne sont pas prises en compte.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • searchID (Identifiant de la recherche de veille)

    • (Facultatif) Paramètres de requête :

      • since : Filtre les éléments postérieurs à cette date.
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until : Filtre les éléments antérieurs à cette date.

      • networks : Prend uniquement en compte les éléments provenant des réseaux sociaux suivants :

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments : Prend uniquement en compte les éléments associés aux sentiments suivants :

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword : Prend uniquement en compte les éléments dont les mots-clés extraits incluent celui-ci. La correspondance est exacte et insensible à la casse, sur la base des valeurs renvoyées par l’endpoint des mots-clés. Un mot-clé inconnu renvoie un résultat vide.

      • competitors : Prend uniquement en compte les éléments correspondant à ces concurrents. Disponible uniquement pour les recherches concurrentielles. Les noms utilisés sont ceux renvoyés par l’endpoint des recherches. Un nom inconnu ou une recherche qui n’est pas concurrentielle entraîne le rejet de la requête. Si un élément correspond à deux concurrents, il est comptabilisé pour les deux.

      • groupBy : Omettez ce paramètre pour obtenir le chiffre global.

        • DATE : Renvoie un groupe pour chaque période et indique également la granularité utilisée.

        • NETWORK : Renvoie un groupe par réseau social.

        • COMPETITOR : Renvoie un groupe par concurrent pour une recherche concurrentielle.

  • Récupérer les mots-clés d’une recherche : Répertorie les sujets abordés dans le cadre d’une recherche de veille au cours de la période demandée. Pour chaque mot-clé, le nombre d’éléments le mentionnant, leur classification ainsi que les interactions générées sont indiqués.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • searchID (Identifiant de la recherche de veille)

    • (Facultatif) Paramètres de requête :

      • since : Filtre les éléments postérieurs à cette date.
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until : Filtre les éléments antérieurs à cette date.

      • networks : Prend uniquement en compte les éléments provenant des réseaux sociaux suivants :

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments : Prend uniquement en compte les éléments associés aux sentiments suivants :

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword : Prend uniquement en compte les éléments dont les mots-clés extraits incluent celui-ci. La correspondance est exacte et insensible à la casse, sur la base des valeurs renvoyées par l’endpoint des mots-clés. Un mot-clé inconnu renvoie un résultat vide.

      • competitors : Prend uniquement en compte les éléments correspondant à ces concurrents. Disponible uniquement pour les recherches concurrentielles. Les noms utilisés sont ceux renvoyés par l’endpoint des recherches. Un nom inconnu ou une recherche qui n’est pas concurrentielle entraîne le rejet de la requête. Si un élément correspond à deux concurrents, il est comptabilisé pour les deux.

      • size : Nombre de mots-clés à renvoyer. Doit être compris entre 1 et 100.

  • Récupérer le sentiment d’une recherche : Classe les éléments correspondant à une recherche de veille comme positifs, neutres ou négatifs sur la période demandée.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • searchID (Identifiant de la recherche de veille)

    • (Facultatif) Paramètres de requête :

      • since : Filtre les éléments postérieurs à cette date.
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until : Filtre les éléments antérieurs à cette date.

      • networks : Prend uniquement en compte les éléments provenant des réseaux sociaux suivants :

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments : Prend uniquement en compte les éléments associés aux sentiments suivants :

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword : Prend uniquement en compte les éléments dont les mots-clés extraits incluent celui-ci. La correspondance est exacte et insensible à la casse, sur la base des valeurs renvoyées par l’endpoint des mots-clés. Un mot-clé inconnu renvoie un résultat vide.

      • competitors : Prend uniquement en compte les éléments correspondant à ces concurrents. Disponible uniquement pour les recherches concurrentielles. Les noms utilisés sont ceux renvoyés par l’endpoint des recherches. Un nom inconnu ou une recherche qui n’est pas concurrentielle entraîne le rejet de la requête. Si un élément correspond à deux concurrents, il est comptabilisé pour les deux.

      • groupBy : Omettez ce paramètre pour obtenir le chiffre global.

        • DATE : Renvoie un groupe pour chaque période et indique également la granularité utilisée.

        • NETWORK : Renvoie un groupe par réseau social.

        • COMPETITOR : Renvoie un groupe par concurrent pour une recherche concurrentielle.

  • Récupérer le volume d’une recherche : Compte les éléments correspondant à une recherche de veille sur la période demandée.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • searchID (Identifiant de la recherche de veille)

    • (Facultatif) Paramètres de requête :

      • since : Filtre les éléments postérieurs à cette date.
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until : Filtre les éléments antérieurs à cette date.

      • networks : Prend uniquement en compte les éléments provenant des réseaux sociaux suivants :

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments : Prend uniquement en compte les éléments associés aux sentiments suivants :

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword : Prend uniquement en compte les éléments dont les mots-clés extraits incluent celui-ci. La correspondance est exacte et insensible à la casse, sur la base des valeurs renvoyées par l’endpoint des mots-clés. Un mot-clé inconnu renvoie un résultat vide.

      • competitors : Prend uniquement en compte les éléments correspondant à ces concurrents. Disponible uniquement pour les recherches concurrentielles. Les noms utilisés sont ceux renvoyés par l’endpoint des recherches. Un nom inconnu ou une recherche qui n’est pas concurrentielle entraîne le rejet de la requête. Si un élément correspond à deux concurrents, il est comptabilisé pour les deux.

      • groupBy : Omettez ce paramètre pour obtenir le chiffre global.

        • DATE : Renvoie un groupe pour chaque période et indique également la granularité utilisée.

        • NETWORK : Renvoie un groupe par réseau social.

        • COMPETITOR : Renvoie un groupe par concurrent pour une recherche concurrentielle.

Mentions

  • Rechercher des éléments : Répertorie les éléments correspondant à une recherche de veille, avec des filtres facultatifs sur la date de publication, le réseau social et le sentiment.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceId (Identifiant de l’espace de travail)

      • searchID (Identifiant de la recherche de Social Listening)

    • (Facultatif) Paramètres de requête :

      • since : Filtre les éléments postérieurs à cette date.
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until : Filtre les éléments antérieurs à cette date.

      • networks : Prend uniquement en compte les éléments provenant des réseaux sociaux suivants :

        • FACEBOOK

        • INSTAGRAM

        • TWITTER

        • LINKEDIN

        • TIKTOK

        • YOUTUBE

        • REDDIT

        • WEB_NEWS

        • WEB_BLOG

        • WEB_FORUM

      • sentiments : Prend uniquement en compte les éléments associés aux sentiments suivants :

        • POSITIVE

        • NEGATIVE

        • NEUTRAL

      • keyword : Prend uniquement en compte les éléments dont les mots-clés extraits incluent celui-ci. La correspondance est exacte et insensible à la casse, sur la base des valeurs renvoyées par l’endpoint des mots-clés. Un mot-clé inconnu renvoie un résultat vide.

      • competitors : Prend uniquement en compte les éléments correspondant à ces concurrents. Disponible uniquement pour les recherches concurrentielles. Les noms utilisés sont ceux renvoyés par l’endpoint des recherches. Un nom inconnu ou une recherche qui n’est pas concurrentielle entraîne le rejet de la requête. Si un élément correspond à deux concurrents, il est comptabilisé pour les deux.

      • offset : Décalage renvoyé par la réponse précédente, permettant de consulter la page suivante.

      • limit : Nombre maximal d’éléments à renvoyer par page. Doit être compris entre 1 et 25.

      • orderBy : Champ selon lequel les éléments sont triés.

        • DATE : Selon la date de publication

        • ENGAGEMENT : Selon le nombre d’interactions générées par l’élément.


Analytique & Rapport

La section Analytique & Rapport de l’Open API vous permet de récupérer les données de reporting Audience, Contenu, Community Management et Concurrent.

Rapports

L’Open API Analytics est compatible avec les réseaux sociaux suivants :

  • Facebook

  • Instagram

  • LinkedIn

  • TikTok

  • YouTube

Remarque : En raison de restrictions liées aux conditions d’utilisation, X (Twitter) n’est pas pris en charge par l’Open API Analytics.

L’Open API Analytics donne accès aux mêmes données que celles disponibles via les exports CSV des rapports Agorapulse, notamment :

  • Récupérer les données du rapport Audience :

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceID (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil social)

      • since (Date de début de la période de reporting)
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until (Date de fin de la période de reporting)

  • Récupérer les données du rapport Community Management : Données du rapport Community Management

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceID (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil social)

      • since (Date de début de la période de reporting)
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until (Date de fin de la période de reporting)

  • Récupérer les données du rapport Content : Données du rapport Content

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceID (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil social)

      • since (Date de début de la période de reporting)
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until (Date de fin de la période de reporting

Concurrents

Récupérez les données d’audience de vos concurrents. Les données de concurrence sont uniquement disponibles pour les Pages Facebook et les comptes professionnels Instagram. Les données suivantes peuvent être récupérées :

  • Récupérer les concurrents : Récupère les concurrents suivis pour le profil social.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceID (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil social)

  • Récupérer les données du rapport Competitor : Récupère le rapport agrégé sur les concurrents pour le profil.

    • Paramètres obligatoires :

      • organizationID (Identifiant de l’organisation)

      • workspaceID (Identifiant de l’espace de travail)

      • profileUid (Identifiant du profil social)

      • since (Date de début de la période de reporting)
        ​Remarque : les dates doivent être saisies au format YYYY-MM-DD (par exemple : 2024-03-20).

      • until (Date de fin de la période de reporting)

Comment interpréter les erreurs

L’API utilise les codes de statut HTTP standards. Une réponse 2xx indique que la requête a abouti, une réponse 4xx indique un problème lié à votre requête, par exemple un paramètre manquant, une ressource inconnue ou une clé API manquante, tandis qu’une réponse 5xx indique un problème du côté d’Agorapulse.

Les réponses d’erreur contiennent un corps au format JSON, à l’exception des codes 405, 406 et 415, qui renvoient uniquement un statut.

Exemple :

{   "code": 1005,   "subCode": 1104,   "message": "Media not found: pubmedia_abc123" }

  • code : Identifie la catégorie d’erreur. Un code global couvre les valeurs suivantes : 1 pour les erreurs internes, 2 pour les erreurs d’autorisation, 3 pour les limites de requêtes dépassées, 4 pour les données d’entrée non traitables et 5 pour les erreurs de validation. Toute autre valeur identifie le composant à l’origine de l’erreur, qui correspond généralement à la fonctionnalité concernée par votre requête. Lorsqu’une requête correspond à aucun endpoint, elle est rejetée directement par la passerelle API et renvoie le code propre à la passerelle, 1013.

  • subCode : Ce champ est facultatif. Lorsqu’il est présent, il permet d’identifier plus précisément la cause de l’erreur au sein du composant concerné. Les endpoints qui renvoient ce champ documentent ses différentes valeurs.

  • message : Fournit une explication compréhensible de l’erreur. Ne l’utilisez pas pour effectuer des traitements dans votre code, car sa formulation peut être amenée à changer.

Avez-vous trouvé la réponse à votre question ?