API de rapprochement d’utilisation facturée et non facturée par jour v2 (GA)

S’applique à : Espace partenaires (indisponible dans Azure Government ou Azure China 21Vianet.)

Notre nouvelle API asynchrone offre un moyen plus rapide et plus efficace d’accéder à vos données de facturation et de rapprochement via des objets blob Azure. Au lieu de conserver une connexion ouverte pendant des heures ou de traiter des lots de 2 000 éléments de ligne, vous pouvez maintenant simplifier votre flux de travail.

Les nouvelles API de rapprochement d’utilisation évaluées par le commerce utilisent des techniques avancées telles que la clé de valet et les modèles de demande-réponse asynchrones. Ces API vous fournissent un jeton de signature d’accès partagé (SAP) que vous pouvez utiliser pour accéder à tous les attributs ou à un sous-ensemble des données de rapprochement d’utilisation évaluées quotidiennement.

Nos API utilisent des techniques optimisées pour améliorer votre efficacité, ce qui vous permet d’obtenir des résultats plus rapides avec moins d’efforts. Adoptez ces API pour simplifier l’accès à vos données et améliorer votre efficacité globale.

Vous ne pouvez utiliser ces API pour le cloud public/mondial MS Graph que maintenant. Ils ne sont pas encore disponibles pour Azure Government ou Azure China 21Vianet.

Présentation de l’API

Pour vous aider à récupérer les nouveaux éléments de ligne d’utilisation facturés quotidiennement au commerce , nous proposons deux points de terminaison d’API clés. Voici un guide simplifié pour vous aider à démarrer :

Point de terminaison de ligne d’utilisation

Tout d’abord, utilisez cette API pour récupérer les nouveaux éléments de ligne d’utilisation quotidiens du commerce . Lorsque vous effectuez une requête, vous recevez un état HTTP 202 et un en-tête d’emplacement avec une URL. Interrogez régulièrement cette URL jusqu’à ce que vous obteniez un état de réussite et une URL de manifeste.

Point de terminaison d’état de l’opération

Ensuite, continuez à vérifier l’état de l’opération en appelant cette API à intervalles réguliers. Si les données ne sont pas prêtes, la réponse inclut un en-tête Retry-After indiquant la durée d’attente avant de réessayer. Une fois l’opération terminée, vous recevez une ressource de manifeste avec un lien de dossier de stockage pour télécharger les données d’utilisation. La réponse segmente les fichiers pour améliorer le débit et permettre un parallélisme d’E/S.

En suivant ces étapes, vous pouvez gérer efficacement votre processus de rapprochement de facture.

Diagramme de séquence

Voici un diagramme de séquence qui montre les étapes de téléchargement des données de rapprochement.

Séquence d’actions utilisateur

Pour récupérer les nouveaux éléments de ligne de rapprochement d’utilisation évalués quotidiennement par le commerce , procédez comme suit :

Étape 1 : Envoyer une demande

Envoyez une requête POST au point de terminaison de l’API.

Obtenir des éléments de ligne d’utilisation non facturés tous les jours

Obtenez de nouveaux éléments de ligne d’utilisation quotidiens non facturés pour le mois ou le dernier mois calendrier ou la période de facturation.

Requête d’API

POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/unbilled/export

Accept: application/json

Content-Type: application/json

{

"currencyCode": "USD",

"billingPeriod": "current",

"attributeSet": "basic"

}

Corps de la demande

En-têtes de requête

Pour demander des en-têtes pour l’API, consultez Fiabilité et prise en charge.

Réponse de l’API

HTTP/1.1 202 Accepted  
Location: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

L’API répond généralement avec un état HTTP 202. Vous pouvez également rencontrer d’autres états en fonction de vos demandes. Ces états sont répertoriés dans la section États de réponse de l’API Standard.

Obtenir les éléments de ligne d’utilisation facturés tous les jours

Obtenez les nouveaux éléments de ligne d’utilisation facturés quotidiennement pour une facture pour la période de facturation fermée.

Requête d’API

POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/billed/export

{  
"invoiceId": "G00012345",  
"attributeSet": "full"  
}

Paramètres de requête

S/O

Corps de la demande

En-tête de requête

En-têtes de requête pour l’API. Pour en savoir plus, consultez la fiabilité et la prise en charge.

Réponse de l’API

HTTP/1.1 202 Accepté
Emplacement : https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

Lorsque vous utilisez l’API, elle retourne généralement un état HTTP 202. Pour obtenir d’autres états possibles en fonction de vos demandes, consultez Statuses.

Étape 2 : Vérifier l’état de la demande

Pour suivre l’état d’une demande, veillez à recevoir une réponse HTTP 200 indiquant « réussi » ou « échoué ». Si elle réussit, vous trouvez l’URL du manifeste dans l’attribut « resourceLocation ». Cet attribut fournit un point de terminaison pour accéder aux informations requises.

Obtenir l’état de l’opération

Récupère l’état d’une demande.

Requête d’API

GET https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

Paramètres de la demande

En-tête de requête

Pour demander des en-têtes pour l’API, consultez Fiabilité et prise en charge.

Corps de la demande

N/A.

État de la réponse

Outre les états HTTP standard répertoriés dans les états de réponse de l’API Standard, l’API peut également retourner l’état HTTP suivant :

Charge utile de réponse

La charge utile de réponse de l’API inclut les attributs suivants :

Objet Resource Location

Requête d’API

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Réponse de l’API

La réponse recommande d’attendre 10 secondes avant de réessayer lors du traitement des données.

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"id": "9ab9cb54-d07f-4f52-9ea6-a09d7de52c14",  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-05Z",  
"status": "running"  
}

Requête d’API

(10 secondes après la demande précédente...)

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Réponse de l’API

L’API retourne l’état « réussi » et l’URI de « resourceLocation ».

HTTP/1.1 200 OK  
Content-Type: application/json  
{

    "@odata.context": "https://graph.microsoft.com/v1.0/\$metadata#reports/partners/billing/operations/\$entity",

    "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation",

    "id": "f2170b13-6a8e-47d6-b481-6988490dc0cb",

    "createdDateTime": "2023-12-05T21:17:29Z",

    "lastActionDateTime": "2023-12-05T21:18:00.8897902Z",

    "status": "succeeded",

    "resourceLocation": {

        "id": "44e8500b-ab92-490e-8ac3-90500a1d3427",

        "createdDateTime": "2023-11-06T19:58:47.513Z",

        "schemaVersion": "2",

        "dataFormat": "compressedJSON",

        "partitionType": "default",

        "eTag": "RwDrn7fbiTXy6UULE",

        "partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0",

        "rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/path_id",

        "sasToken": "{token}",

        "blobCount": 1,

        "blobs": \[

            {

                "name": "part-00123-5a93fa5d-749f-48bc-a372-9b021d93c3fa.c000.json.gz",

                "partitionValue": "default"

            }

        \]

    }

}

Étape 3 : Télécharger les éléments de ligne de rapprochement d’utilisation évalués quotidiennement à partir du stockage Blob Azure

Tout d’abord, vous devez obtenir le jeton de signature d’accès partagé (SAP) et l’emplacement de stockage d’objets blob. Vous trouverez ces détails dans les propriétés « sasToken » et « rootDirectory » de la réponse de l’API de charge utile du manifeste. Ensuite, pour télécharger et décompresser le fichier blob, utilisez le kit sdk/outil Stockage Azure. Il est au format JSONLines .

États de réponse de l’API standard

Vous pouvez recevoir ces états HTTP à partir de la réponse de l’API :

Comparer les versions bêta et ga

Consultez le tableau de comparaison pour voir les différences entre la version bêta et les versions en disponibilité générale. Si vous utilisez actuellement la version bêta, la transition vers la version ga est simple et facile.

Attributs quotidiens de l’élément de ligne de rapprochement de l’utilisation

Pour comparer les attributs retournés par l’API de rapprochement de facture facturée pour les ensembles d’attributs « full » ou « basic », reportez-vous au tableau suivant. Pour en savoir plus sur ces attributs, consultez cette documentation.

Exemple de code

Pour utiliser cette API, consultez le lien suivant, qui inclut l’exemple de code C#.

Exemples d’API de l’Espace partenaires : obtenir des données de reconquête de facturation.