GET/api/v4/social/limits

Obtenir les limites et l’utilisation du forfait Social

Renvoie le plafond de connexions Social du compte et l’usage des connexions facturables, actives et libérées sur la période de facturation en cours.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Cet endpoint ne prend aucun paramètre.

Réponses

200The account's Social caps and current usage. `brands` is null because brands are unlimited on API plans. Here 118 connections are billable: 112 still connected, plus 6 disconnected during this period whose slots are held until renewal.
Response
{  "data": {    "fetchAccountLimits": {      "brands": null,      "connections": 135,      "maxConnections": 135,      "users": 10,      "aiCredits": 500,      "usage": {        "brands": 31,        "connections": 118,        "connectionsActive": 112,        "connectionsReleased": 6      }    }  }}
401Unauthenticated, missing or invalid API key.

Indique ce que votre forfait Social autorise et la part que vous avez utilisée. Consultez ces informations avant de générer un lien de connexion, afin de pouvoir informer un client qu’il n’a plus de capacité disponible plutôt que de lui afficher un SY95042 résultant d’un échec d’écriture.

ChampSignification
brandsQuota de marques. null pour tous les forfaits API, ce qui signifie qu’il est illimité. Interprétez toute valeur null ici comme « sans plafond », et non comme zéro.
connectionsConnexions incluses dans l’abonnement : celles du niveau de forfait, auxquelles s’ajoutent celles des packs de connexions achetés.
maxConnectionsLe plafond effectivement appliqué lorsque vous ajoutez une connexion. Pour les forfaits API, il est égal à connections.
usersPlaces utilisateur incluses dans le forfait.
aiCreditsCrédits de génération de contenu inclus dans la période en cours.
usage.brandsMarques existantes à ce jour. À titre indicatif : aucune limite ne s’applique à ce nombre.
usage.connectionsLe nombre de connexions facturables, et le seul auquel le plafond s’applique. Connexions distinctes utilisées à un moment quelconque de la période de facturation en cours : celles toujours connectées, plus celles libérées au cours de cette période. Comparez ce nombre à maxConnections.
usage.connectionsActiveConnexions actuellement connectées. Ce nombre est toujours inférieur ou égal à usage.connections. Utile pour montrer à un client ce qui est actif ; ce n’est pas le nombre qui lui est facturé.
usage.connectionsReleasedConnexions déconnectées pendant la période de facturation en cours et dont les emplacements restent réservés. Cette capacité redevient disponible au renouvellement.

usage.connections correspond exactement à usage.connectionsActive + usage.connectionsReleased.

Un emplacement libéré reste réservé jusqu’à la fin de la période

Déconnecter un canal le met immédiatement hors ligne, mais ne rend pas son emplacement disponible. Au cours d’une période de facturation, le plafond tient compte des connexions distinctes que vous avez utilisées, qu’elles soient toujours connectées ou non ; l’emplacement reste donc consommé jusqu’au renouvellement de l’abonnement. Trois conséquences à prendre en compte dans votre code :

  • La capacité disponible est maxConnections - usage.connections, jamais maxConnections - usage.connectionsActive. Utiliser le nombre de connexions actives indiquera au client une capacité disponible qu’il n’a pas, et le prochain lien de connexion renverra SY95042.
  • Reconnecter le même compte à la même marque est gratuit. Si un client reconnecte une Page qu’il avait déconnectée de cette marque plus tôt dans la période, elle réutilise l’emplacement qui lui est déjà réservé : connectionsActive augmente, connectionsReleased diminue et connections ne change pas. Rattacher cette même Page à une marque différente utilise un emplacement distinct, et l’emplacement initial reste réservé jusqu’au renouvellement.
  • connectionsReleased vous permet de prévoir la capacité récupérée au renouvellement. Il s’agit précisément du nombre d’emplacements qui redeviennent disponibles dans le quota commun au début du cycle suivant, et donc de la valeur à montrer à un client qui hésite entre attendre le renouvellement et acheter un pack aujourd’hui.

Ce fonctionnement suit celui du reste du modèle de facturation : la capacité que vous achetez est disponible immédiatement, et celle à laquelle vous renoncez est retirée à la fin du cycle. Consultez Forfaits et options supplémentaires.

Cas d’utilisation : une vérification préalable dans votre parcours d’intégration. Avant de proposer à un client le bouton « connecter un compte », comparez usage.connections — le nombre de connexions facturables, et non connectionsActive — à maxConnections. S’il ne reste aucune capacité disponible, proposez-lui une option supplémentaire ou un passage à un forfait supérieur plutôt que de laisser POST /social/brands/{brandId}/connections/link échouer. Il n’existe aucune vérification équivalente pour les marques : la création d’une marque avec POST /social/brands n’est jamais limitée par un manque de capacité.

Cas d’utilisation : dimensionner la prochaine option supplémentaire. Les packs de connexions sont vendus par lots de cinq ; maxConnections - usage.connections vous indique donc directement combien de réseaux vous pouvez encore connecter, et ceil((needed - headroom) / 5) correspond au nombre de packs à acheter.

Remarques.

  • Les marques sont illimitées et ne font l’objet d’aucun décompte d’utilisation. brands renvoie null pour les comptes listingsAPI. Le code client qui traitait cette valeur comme un plafond entier doit prendre en charge null et ne doit pas afficher « 0 marque restante ».
  • Les connexions constituent un quota commun à l’ensemble du compte, et non un quota par marque. Une marque peut avoir autant de connexions que vous le souhaitez, dans la limite des cinq réseaux qu’elle prend en charge, tant que le quota commun dispose de capacité. Consultez Forfaits et options supplémentaires.
  • Cet endpoint couvre uniquement l’abonnement Social. Les plafonds d’établissements relèvent de l’abonnement Listings et sont appliqués séparément par POST /locations, qui renvoie SY10155 lorsque le compte ne dispose d’aucun forfait Listings.
  • Les comptes en libre-service sont limités à 250 connexions, quel que soit le nombre de packs achetés. Au-delà, le compte doit passer à Enterprise.
  • La capacité disponible ne garantit pas que la connexion à Instagram réussira. Instagram autorise uniquement un compte Business ou Creator lié à une Page Facebook ; un compte personnel est refusé sur l’écran de consentement de Meta, et non par ce plafond. Si un client dispose de capacité ici et que le lien de connexion échoue malgré tout pour Instagram, il faut convertir le compte plutôt qu’ajouter de la capacité.
  • Les chiffres sont actualisés en temps réel, mais une libération ne constitue pas un remboursement. Une déconnexion avec disconnect, ou l’archivage d’une marque, est reflété ici dès la lecture suivante : usage.connectionsActive diminue et usage.connectionsReleased augmente d’autant. usage.connections reste inchangé, car l’emplacement reste réservé jusqu’à la fin de la période. Les deux modes de libération se comportent de manière identique.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/limits' \  -H "Authorization: API $LISTINGSAPI_KEY"