Passer au contenu
/
Créer une campagne

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

Créer une campagne

Requête

Créez une nouvelle 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.

Corpsapplication/jsonobligatoire
campaign_codestringobligatoire

Nom de campagne.

campaign_namesobjectobligatoire

Noms localisés de la campagne.

campaign_names.​arstring

Arabe.

campaign_names.​bgstring

Bulgare.

campaign_names.​cnstring

Chinois (simplifié).

campaign_names.​csstring

Tchèque.

campaign_names.​destring

Allemand.

campaign_names.​enstring

Anglais.

campaign_names.​esstring

Espagnol.

campaign_names.​frstring

Français.

campaign_names.​hestring

Hébreu.

campaign_names.​itstring

Italien.

campaign_names.​jastring

Japonais.

campaign_names.​kostring

Coréen.

campaign_names.​plstring

Polonais.

campaign_names.​ptstring

Portugais.

campaign_names.​rostring

Roumain.

campaign_names.​rustring

Russe.

campaign_names.​thstring

Thaïlandais.

campaign_names.​trstring

Turc.

campaign_names.​twstring

Chinois (traditionnel).

campaign_names.​vistring

Vietnamien.

campaign_redeems_count_for_userinteger

Nombre maximal de coupons que l'utilisateur peut échanger dans le cadre de la campagne. Si null est passé, le nombre d'utilisations est illimité.

expiration_datestring(datetime)

Date de fin de la campagne au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.

project_idintegerobligatoire

ID de projet.

redeems_countinteger

Nombre maximal de coupons à échanger. Si null est passé, le nombre d'utilisations est illimité.

redeems_count_for_userinteger

Nombre maximal de coupons que l'utilisateur peut échanger. Si null est passé, le nombre d'utilisations est illimité.

subscription_couponobject

Paramètres de l'abonnement dans la récompense.

virtual_currency_amountnumber(float)

Quantité de la monnaie virtuelle dans la récompense.

virtual_itemsobject

Tableau des paramètres des objets virtuels dans la récompense.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

Réponses

Created.

Corpsapplication/json
idinteger
Exemple: 9134
Réponse
application/json
{
  "id": 9134
}

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.

Subscription management

Opérations