Obtenir la liste des prospects et des opportunités
Cet article explique comment obtenir la liste des prospects reçus de la page fournisseur de solutions Microsoft et des opportunités de co-vente reçues de vendeurs Microsoft ou d’autres partenaires. Ce processus récupère également la liste des opportunités de co-vente ou des transactions de pipeline créées par votre organisation.
Remarque
Les prospects reçus de la Place de marché commerciale Microsoft (Place de marché Azure et AppSource) ne sont pas pris en charge.
Prérequis
- Informations d’identification, comme décrit dans Authentification auprès de l’API Partenaire. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application et de l’utilisateur.
- Cette API prend actuellement en charge uniquement l’accès utilisateur où les partenaires doivent se trouver dans l’un des rôles suivants : Administration global, Référence Administration ou Utilisateur de référence.
Demande REST
Syntaxe de la requête
| Méthode | URI de demande |
|---|---|
| GET | https://api.partner.microsoft.com/v1.0/engagements/referrals |
Opérations OData prises en charge
| Nom | Description | Obligatoire | Exemple |
|---|---|---|---|
| $select | Sélectionne les champs | Non | /referrals?$select=id,status,customerProfile |
| $filter | Filtre les résultats | Recommandé | /referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2' /referrals?$filter=status eq 'New' and qualification eq 'SalesQualified' /referrals?$filter=customerProfile/address/country eq 'US' and direction eq 'Incoming' |
| $orderby | Trier les résultats | Recommandé | /referrals?$orderby=createdDateTime desc |
Paramètres orderby pris en charge
Utilisez les paramètres de $orderby suivants pour trier la liste des prospects et des opportunités
| Nom | Type | Description |
|---|---|---|
| createdDateTime | Date/Heure | Date et heure de création du prospect ou de l’opportunité |
| updatedDateTime | Date/Heure | Mettre à jour la date et l’heure du prospect ou de l’opportunité |
En-têtes de requête
Pour plus d’informations, consultez En-têtes de l’API REST Partenaire.
Corps de la demande
Aucun.
Exemple de requête
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Réponse REST
En cas de réussite, le corps de la réponse contient une collection de prospects et/ou d’opportunités.
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 d’autres informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres.
Exemple de réponse
HTTP/1.1 200 OK
Content-Type: application/json
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
{
"@odata.context": "http://api.partner.microsoft.com/v1.0/$metadata#Referrals",
"@odata.count": 1,
"value": [
{
"id": "c5fbb3b6-be74-4795-9fb5-4324c73fed37",
"engagementId": "65edc0b5-3485-41b7-a17e-dfa9ef4706e2",
"organizationId": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
"organizationName": "Contoso Company",
"createdDateTime": "2020-10-30T21:03:00.0000000Z",
"updatedDateTime": "2020-10-30T21:03:00.0000000Z",
"status": "New",
"substatus": "Pending",
"qualification": "Direct",
"type": "Independent",
"direction": "Incoming",
"customerProfile": {
"name": "Fabrikam Customer Inc",
"address": {
"addressLine1": "One Microsoft Way",
"addressLine2": "",
"city": "Redmond",
"state": "WA",
"postalCode": "98052",
"country": "US"
}
},
"details": {
"notes": "We are interested in deploying Microsoft 365 and are looking for support in training our employees. Can you help?",
"dealValue": 10000,
"currency": "USD",
"closingDateTime": "2020-12-01T00:00:00Z",
"requirements": {
"industries": [ { "id": "Education" } ],
"products": [ { "id": "Microsoft365" } ],
"services": [ { "id": "LearningAndCertification" } ],
"solutions": [ { "id": "SOL-Microsoft365", "name": "Microsoft365" }
]
}
},
"links": {
"relatedReferrals": {
"uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=engagementId eq '65edc0b5-3485-41b7-a17e-dfa9ef4706e2'",
"method": "GET"
},
"self": {
"uri": "https://api.partner.microsoft.com/v1.0/engagements/referrals/c5fbb3b6-be74-4795-9fb5-4324c73fed37",
"method": "GET"
}
}
}
],
"@odata.nextLink": "http://api.partner.microsoft.com/v1.0/referrals?$skiptoken=k181pEdP0ykypkieJfcxX"
}
Utilisez la @odata.nextLink page suivante des résultats.
Remarque
Les champs de cet exemple ne sont pas exhaustifs. La réponse de l’API réelle contient davantage de champs tels que les équipes client et partenaire. Pour obtenir la liste complète des champs pris en charge, consultez les ressources de référence.
Exemples de demandes
L’exemple suivant obtient les 10 meilleures opportunités de co-vente entrantes les plus récentes. La demande extrait les opportunités initiées par un représentant commercial Microsoft ou un autre partenaire, invitant votre organisation à participer à une activité de co-vente.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(type eq 'Shared' and direction eq 'Incoming')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
L’exemple suivant obtient les prospects entrants et les opportunités les plus récents auxquels ils n’ont pas répondu.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$top=10&$filter=(direction eq 'Incoming' and substatus eq 'Pending')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Important
Si vous ne répondez pas à un prospect ou à une opportunité dans le délai imparti (actuellement 14 jours), nous allons l’archiver en tant qu’expiré et informer Microsoft ou le partenaire qui vous a envoyé cette opportunité.
L’exemple suivant obtient les opportunités de co-vente actives les plus récentes initiées par votre organisation et travaillées par un vendeur spécifique.
GET https://api.partner.microsoft.com/v1.0/engagements/referrals?$filter=status eq 'Active' and direction eq 'Outgoing' and type eq 'Shared' and team/any(t:t/email eq 'r2d2@contoso.com')&$orderby=createdDateTime desc HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
Étapes suivantes
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour