Utiliser la prise en charge de l’éditeur — ou délibérément nonTous les articles

Utiliser la prise en charge de l’éditeur — ou délibérément non

Quand l’éditeur paie les requêtes, l’entreprise doit tout de même savoir ce qu’elle supporte. Ce cas montre le côté du bénéficiaire.

Publié: 2026-09-12Temps de lecture: 4 minAPI tapinomahub & processus
API & processusAPICommerce automobileAtelier

Un atelier utilise les fonctions tapinomahub via son logiciel d’atelier. L’éditeur a proposé de prendre en charge les requêtes véhicule. Mais l’atelier a aussi son solde et ses conditions — et ne veut pas découvrir sur la facture qui a payé quelle requête.

Utiliser la prise en charge de l’éditeur — ou délibérément nonEntrée : l’éditeur a accordé une prise en charge ; l’entreprise choisit les conditions 1. Consulter les prises en charge (GET /client/sponsorship-grants/received): endpointKeys, durée et partnerTermsAllowed par prise en charge reçue 2. Choisir les conditions (PUT /client/sponsorship-grants/received/{grantReference}/billing-mode): mode own ou partner — partner seulement si le sponsor l’a autorisé 3. Lire le solde (GET /client/credits): avec billingMode partner, les montants sont null — votre solde reste intact 4. Lire la consommation (GET /client/usage): Consommation du plan et usage par endpoint sur la période Sortie : une entreprise qui sait, pour chaque requête, qui la paie Hors prise en charge, l’API répond sous partner par 402 partner_terms_not_covered au lieu de débiter discrètement votre solde.Utiliser la prise en charge de l’éditeur — ou délibérémentnonEntrée : l’éditeur a accordé une prise en charge ; l’entreprise choisit les conditions01Consulter les prises en chargeGET /client/sponsorship-grants/receivedendpointKeys, durée et partnerTermsAllowed par prise en charge reçue02Choisir les conditionsPUT /client/sponsorship-grants/received/{grantReference}/billing-modemode own ou partner — partner seulement si le sponsor l’a autorisé03Lire le soldeGET /client/creditsavec billingMode partner, les montants sont null — votre solde reste intact04Lire la consommationGET /client/usageConsommation du plan et usage par endpoint sur la périodeSortie : une entreprise qui sait, pour chaque requête, qui la paieHors prise en charge, l’API répond sous partner par 402 partner_terms_not_covered au lieu de débiterdiscrètement votre solde.
Quatre appels côté bénéficiaire. Le choix des conditions est réversible à tout moment.

Dans le Hub, la prise en charge est une relation explicite à deux côtés : le sponsor l’accorde et peut autoriser le choix des conditions, le bénéficiaire la voit et décide. Rien ne se fait en silence — aux conditions partenaire, pas même quand une requête sort de la prise en charge.

SurfaceRôles
HubAtelier, Recycleurs automobiles, Concession

Ce que ce cas suppose

  • Une prise en charge accordée. Elle naît chez le sponsor ; le bénéficiaire ne peut pas la créer.
  • L’autorisation des conditions partenaire, si elles doivent être choisies. Sans partnerTermsAllowed, choisir partner renvoie 403.
  • Un regard sur les endpoints couverts. endpointKeys indique à quoi s’applique la prise en charge — toute requête n’y figure pas.
  • Une décision pour les requêtes hors prise en charge. Sous partner, une requête non couverte est refusée, non payée sur votre solde.

Le déroulement

Le tableau indique pour chaque étape l’appel compétent et ce qui existe ensuite. La justification de l’étape figure en dessous.

La chaîne d’appels de ce cas d’usage
ÉtapeAppelCe qui existe ensuite
Consulter les prises en chargeGET /client/sponsorship-grants/receivedendpointKeys, durée et partnerTermsAllowed par prise en charge reçue
Choisir les conditionsPUT /client/sponsorship-grants/received/{grantReference}/billing-modemode own ou partner — partner seulement si le sponsor l’a autorisé
Lire le soldeGET /client/creditsavec billingMode partner, les montants sont null — votre solde reste intact
Lire la consommationGET /client/usageConsommation du plan et usage par endpoint sur la période

Pourquoi chaque étape est nécessaire

  1. Consulter les prises en charge. GET /client/sponsorship-grants/received liste par prise en charge reference, sponsor, endpointKeys, startsAt, endsAt, active, partnerTermsAllowed et partnerTermsChosen. On y voit ce qui est couvert et si le choix est ouvert.
  2. Choisir les conditions. PUT /client/sponsorship-grants/received/{grantReference}/billing-mode prend mode avec own ou partner. Sous partner, votre solde reste intact ; sans autorisation du sponsor, l’appel renvoie 403. Si le sponsor retire l’autorisation, le choix tombe avec elle.
  3. Lire le solde. GET /client/credits renvoie balanceCents, creditLimitCents et availableCents. Si l’entreprise travaille aux conditions partenaire, billingMode vaut partner et les montants sont null — son solde n’est pas débité, donc pas affiché.
  4. Lire la consommation. GET /client/usage indique la période, par plan used, includedMonthlyQuantity et remaining, et par endpoint used et chargedCents. On vérifie ainsi que les requêtes sont allées là où le choix devait les envoyer.
Travailler aux conditions du sponsor
curl -X PUT \
  -H 'X-Api-Key: <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{"mode":"partner"}' \
  'https://api.tapinomahub.com/client/sponsorship-grants/received/<grantReference>/billing-mode'

Ce que l’on obtient

Au final, l’entreprise sait pour chaque requête qui paie : aux conditions partenaire, le sponsor pour les endpoints couverts ; à ses propres conditions, la facturation porte d’abord sur son propre forfait et son propre solde, et le sponsor n’intervient qu’en recours. Et aux conditions partenaire, une requête hors prise en charge est refusée visiblement, au lieu de coûter du solde en silence.

Où cela figure dans la documentation

Les listes de champs contractuelles, les codes d’erreur et les réponses d’exemple se trouvent dans le contrat OpenAPI de cette surface, à l’adresse docs.tapinomahub.com (tapinoma-hub). Tous les cas d’usage classés par surface et par rôle : aperçu des cas d’usage.

Sources et références juridiques

Questions fréquentes

Dois-je accepter la prise en charge ?

Non. Vous pouvez rester à vos propres conditions. Le choix de partner n’est possible que si le sponsor l’a autorisé.

Pourquoi mon solde affiche-t-il null ?

Parce que vous travaillez aux conditions partenaire. Votre solde n’est alors pas débité, donc pas affiché.

Qu’advient-il d’une requête non couverte ?

Sous partner, elle est refusée par 402 partner_terms_not_covered. Elle n’est pas payée discrètement sur votre solde.