Créer un transfert pour le nouveau commerce à l’aide des API REST de l’Espace partenaires

Article
09/27/2024

Les partenaires peuvent transférer de nouveaux abonnements commerciaux d’un partenaire de transaction vers un autre. Un partenaire cible crée la demande de transfert. Le partenaire source met à jour le transfert avec les détails de l’élément de ligne. Cette rubrique explique l’API qu’un partenaire cible appelle pour créer la demande de transfert. Cette rubrique s’applique uniquement aux réservations azure Plan, aux plans d’épargne et aux abonnements et aux nouveaux abonnements commerciaux basés sur des licences. Vous trouverez des informations plus précieuses dans la documentation sur le transfert d’abonnements.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.
ID du client (customer-tenant-ID). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page du compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-ID).
Rôles appropriés : Agent d’administration

Demande REST

Syntaxe de la requête

Method	URI de demande
POST	{baseURL}/v1/customers/{customer-ID}/transferts HTTP/1.1

Paramètre d’URI

Utilisez le paramètre de chemin d’accès suivant pour identifier le client.

Nom	Type	Requise	Description
id-client	string	Oui	ID client au format GUID qui identifie le client.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Ce tableau décrit les propriétés TransferEntity dans le corps de la demande pour la création d’une demande de transfert de commerce.

Propriété	Type	Requise	Description
sourcePartnerTenantId	string	Oui	ID partenaire au format GUID qui identifie le partenaire qui lance le transfert.
sourcePartnerName	string	Oui	Nom de l’organisation du partenaire qui lance le transfert.
customerEmailId	string	Oui	Chaîne du client pour recevoir des notifications de la création du transfert.
customerName	string	Non	facultatif. Nom du client dont les abonnements sont transférés.
targetPartnerTenantId	string	Non	ID de locataire partenaire au format GUID qui identifie le partenaire auquel le transfert est ciblé. Le contexte d’autorisation du partenaire est résolu en ID de locataire partenaire s’il est omis.
targetPartnerEmailId	string	Non	ID de locataire partenaire au format GUID qui identifie le partenaire auquel le transfert est ciblé. Le contexte d’autorisation du partenaire est résolu en ID de locataire partenaire s’il est omis.
transferType	string	Oui	Chaîne définissant le type de transfert. 3 représente NewCommerce et doit être utilisé pour le plan Azure et les nouveaux abonnements basés sur des licences commerciales.

Exemple de requête

{
    "id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
    "status": "InProgress",
    "transferType": 3,
    "customerEmailId": "",
    "createdTime": "2024-04-30T18:31:41.5133355Z",
    "lastModifiedTime": "2024-05-01T00:51:55Z",
    "expirationTime": "2024-05-31T00:00:00Z",
    "customerName": "ipdbtrans2",
    "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "partnertenantid": "a94dcde1-ecd7-wace-a6ef-ef73ba6b8ba5",
    "sourcePartnerName": "Test_Test_IP4_AG",
    "sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "targetPartnerName": "Test_Test_DB_AG",
    "targetPartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
    "transferDirection": 2,
    "ignoreEligibilityCheck": false,
    "lastModifiedUser": "1671774b-679f-4543-a152-1f8b14006c0e",
    "lineItems": [{
        "id": 0,
        "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
        "billingCycle": "unknown",
        "quantity": 0,
        "productType": 5,
        "status": "InProgress"
    }],
    "links": {
        "self": {
            "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
            "method": "GET",
            "headers": []
        }
    }
}

Réponse REST

Si elle réussit, cette méthode retourne la ressource TransferEnity remplie dans le corps de la réponse.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et plus d’informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur.

Exemple de réponse

HTTP/1.1 201 Created
Content-Length: 138
Content-Type: application/json; charset=utf-8
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US,en-US

{
"id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"status": "Pending",
"transferType": 3,
"customerEmailId": "",
"createdTime": "2024-04-30T18:31:41.5133355Z",
"lastModifiedTime": "2024-04-30T18:31:41Z",
"expirationTime": "2024-05-31T00:00:00Z",
"customerName": "ipdbtrans2",
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"partnertenantid": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"sourcePartnerName": "Test_Test_IP4_AG",
"sourcePartnerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"targetPartnerName": "Test_Test_DB_AG",
"targetPartnerTenantId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"transferDirection": 1,
"ignoreEligibilityCheck": false,
"lastModifiedUser": "7ffdaa28-3b1c-4a61-b580-e1aa6ecf833c",
"links": {
    "self": {
        "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
        "method": "GET",
        "headers": []
    }
}
}

Partager via