Obter todos os apps
Use esse método na API de envio da Microsoft Store para recuperar dados dos aplicativos registrados em sua conta do Partner Center.
Pré-requisitos
Para usar este método, primeiro você precisa fazer o seguinte:
- Se você ainda não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.
- Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para esse método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.
Solicitar
Esse método tem a seguinte sintaxe. Consulte as seções a seguir para obter exemplos de uso e descrições do cabeçalho e do corpo da solicitação.
| Método | URI da solicitação |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/applications |
Cabeçalho da solicitação
| Cabeçalho | Tipo | Descrição |
|---|---|---|
| Autorização | string | Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário. |
Parâmetros da solicitação
Todos os parâmetros de solicitação são opcionais para esse método. Se você chamar esse método sem parâmetros, a resposta conterá dados para os primeiros 10 aplicativos registrados em sua conta.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| top | int | O número de itens a serem retornados na solicitação (ou seja, o número de aplicativos a serem retornados). Se sua conta tiver mais aplicativos do que o valor especificado na consulta, o corpo da resposta incluirá um caminho de URI relativo que você pode acrescentar ao URI do método para solicitar a próxima página de dados. | Não |
| skip | int | O número de itens a serem ignorados na consulta antes de retornar os itens restantes. Use esse parâmetro para percorrer os conjuntos de dados. Por exemplo, top=10 e skip=0 recuperam os itens de 1 a 10, top=10 e skip=10 recuperam os itens de 11 a 20 e assim por diante. | Não |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Exemplos de solicitação
O exemplo a seguir demonstra como recuperar os primeiros 10 aplicativos registrados em sua conta.
GET https://manage.devcenter.microsoft.com/v1.0/my/applications HTTP/1.1
Authorization: Bearer <your access token>
O exemplo a seguir demonstra como recuperar informações sobre todos os aplicativos registrados em sua conta. Primeiro, obtenha os 10 principais aplicativos:
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=10 HTTP/1.1
Authorization: Bearer <your access token>
Em seguida, chame GET https://manage.devcenter.microsoft.com/v1.0/my/{@nextLink} recursivamente until {@nextlink} é nulo ou não existe na resposta. Por exemplo:
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=20&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=30&top=10 HTTP/1.1
Authorization: Bearer <your access token>
Se você já sabe o número total de aplicativos que tem em sua conta, basta passar esse número no parâmetro superior para obter informações sobre todos os seus aplicativos.
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=23 HTTP/1.1
Authorization: Bearer <your access token>
Resposta
O exemplo a seguir demonstra o corpo da resposta JSON retornado por uma solicitação bem-sucedida para os primeiros 10 aplicativos registrados em uma conta de desenvolvedor com um total de 21 aplicativos. Para resumir, este exemplo mostra apenas os dados dos dois primeiros aplicativos retornados pela solicitação. Para obter mais detalhes sobre os valores no corpo da resposta, consulte a seção a seguir.
{
"@nextLink": "applications?skip=10&top=10",
"value": [
{
"id": "9NBLGGH4R315",
"primaryName": "Contoso sample app",
"packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp_ng6try80pwt52",
"packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp",
"publisherName": "CN=…",
"firstPublishedDate": "2016-03-11T01:32:11.0747851Z",
"pendingApplicationSubmission": {
"id": "1152921504621134883",
"resourceLocation": "applications/9NBLGGH4R315/submissions/1152921504621134883"
}
},
{
"id": "9NBLGGH29DM8",
"primaryName": "Contoso sample app 2",
"packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp2_ng6try80pwt52",
"packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp2",
"publisherName": "CN=…",
"firstPublishedDate": "2016-03-12T01:49:11.0747851Z",
"lastPublishedApplicationSubmission": {
"id": "1152921504621225621",
"resourceLocation": "applications/9NBLGGH29DM8/submissions/1152921504621225621"
}
// Next 8 apps are omitted for brevity ...
}
],
"totalCount": 21
}
Corpo da resposta
| Valor | Type | Descrição |
|---|---|---|
| valor | matriz | Uma matriz de objetos que contém informações sobre cada aplicativo registrado em sua conta. Para obter mais informações sobre os dados em cada objeto, consulte Recurso de aplicativo. |
| @nextLink | string | Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um caminho relativo que você pode acrescentar ao URI de solicitação base https://manage.devcenter.microsoft.com/v1.0/my/ para solicitar a próxima página de dados. Por exemplo, se o parâmetro top do corpo da solicitação inicial estiver definido como 10, mas houver 20 aplicativos registrados em sua conta, o corpo da resposta incluirá um @nextLink valor de applications?skip=10&top=10, que indica que você pode chamar https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 para solicitar os próximos 10 aplicativos. |
| contagem total | int | O número total de linhas no resultado de dados da consulta (ou seja, o número total de aplicativos registrados em sua conta). |
Códigos do Erro
Se a solicitação não puder ser concluída com êxito, a resposta conterá um dos seguintes códigos de erro HTTP.
| Código do erro | Descrição |
|---|---|
| 404 | Nenhum aplicativo foi encontrado. |
| 409 | Os aplicativos usam recursos do Partner Center que atualmente não têm suporte na API de envio da Microsoft Store. |