Passer au contenu
/
Lier une campagne à une p...

Subscriptions API (2.0)

Présentation

  • Version : 2.0
  • Serveurs : https://api.xsolla.com/merchant/v2/

Cette référence API décrit les endpoints pour la gestion des abonnements, des coupons et des promotions. Pour plus d'informations sur les abonnements, consultez le guide du produit et le glossaire.

Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/subscriptions/

Jeton

Opérations

Plans

Opérations

Produits

Opérations

Subscription management

Opérations

Paiements

Opérations

Promotions

Opérations

Coupons

Opérations

Ajouter un coupon à une campagne

Requête

Ajoutez un code promo à une campagne de coupons.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

campaign_idintegerobligatoire

ID de campagne.

Corpsapplication/jsonobligatoire
coupon_codestringobligatoire

Code de coupon.

Exemple: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

Réponses

No content.

Lier une campagne à une promotion

Requête

Associez une campagne de coupons à une promotion spécifique.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

Corpsapplication/jsonobligatoire
campaignsArray of integersobligatoire

Tableau des ID des campagnes.

Exemple: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

Réponses

No content.

Lire un coupon

Requête

Récupération des informations sur le coupon par son code.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

codestringobligatoire

Code de coupon.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Réponses

OK.

Corpsapplication/json
keystring

Clé de l'attribut utilisateur.

list_of_valuesArray of objects

Tableau des valeurs possibles de l'attribut de type enum.

nameobject

Noms localisés d'attributs.

skip_condition_on_nonexistent_keyboolean

Indique si la condition doit être ignorée au cas où la clé n'existe pas.

typestring

Type de clé.

Enum"int""string""enum""date"
visibleboolean
Réponse
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Subscription management

Opérations