Passer au contenu
/
Réviser une promotion

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

Définir les périodes de validité

Requête

Définit les plages de dates/heures pendant lesquelles une promotion est valide. Si la promotion est en lecture seule (read_only = true), vous ne pouvez pas modifier les périodes existantes, mais vous pouvez en ajouter de nouvelles.

Remarque

Cet appel API ne contient pas le paramètre de chemin project_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
periodsArray of objects

Plages de dates et d'heures.

periods[].​fromstring(datetime)

Début de la période.

periods[].​offsetstring

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

periods[].​tostring(datetime)

Fin de la période.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Réponses

No content.

Réviser une promotion

Requête

Vous devez vérifier une promotion avant de l'activer. Cette méthode renvoie la liste des erreurs, le cas échéant.

Remarque

Cet appel API ne contient pas le paramètre de chemin project_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.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/review'

Réponses

OK.

Corpsapplication/jsonArray [
componentstring
messagestring
]
Réponse
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

Lire les récompenses

Requête

Obtient la liste des récompenses associées à une promotion.

Remarque

Cet appel API ne contient pas le paramètre de chemin project_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.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards'

Réponses

OK.

Corpsapplication/json
idinteger
itemobject

Définit la récompense pour l'achat des objets virtuels spécifiques.

item.​bonusArray of objects

Objets virtuels supplémentaires octroyés en bonus.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

Nom du plan dans la langue par défaut (en), répète la valeur du paramètre name.en.

item.​bonus[].​quantityinteger

Nombre d'objets virtuels octroyés en bonus.

item.​bonus[].​skustring

UGS de l'objet.

item.​discountArray of objects

Remises pour l'achat des objets virtuels spécifiques.

item.​discount[].​discount_percentnumber(float)

Pourcentage de remise.

item.​discount[].​localized_namestring

Nom du plan dans la langue par défaut (en), répète la valeur du paramètre name.en.

item.​discount[].​max_amountnumber(integer)

Nombre maximal d'objets auxquels la promotion s'applique.

item.​discount[].​skustring

UGS de l'objet.

packageobject

Définit la récompense pour l'achat d'un package de monnaie virtuelle.

package.​bonus_amountnumber(float)

Récompense sous forme d'une quantité absolue de monnaie virtuelle.

package.​bonus_percentnumber(float)

Récompense sous forme d'un pourcentage de la quantité de monnaie virtuelle dans le package.

purchaseobject

Définit la récompense pour l'ensemble de la commande.

purchase.​discount_percentnumber(float)

Pourcentage de remise.

subscriptionobject

Définit la récompense pour l'abonnement.

subscription.​trial_daysinteger

Période d'essai en jours.

Réponse
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

Coupons

Opérations

Subscription management

Opérations