Registrar um aplicativo SaaS
Este artigo explica como registrar um aplicativo SaaS usando o do portal do Microsoft Azure e como obter o token de acesso do editor (token de acesso do Microsoft Entra). O editor usará esse token para autenticar o aplicativo SaaS chamando as APIs de Atendimento SaaS. As APIs de Fulfillment utilizam as credenciais do cliente OAuth 2.0 para efetuar um fluxo de concessão nos endpoints do Microsoft Entra ID (v2.0) a fim de fazer uma solicitação de token de acesso de serviço a serviço.
O Azure Marketplace não impõe quaisquer restrições ao método de autenticação que o seu serviço SaaS utiliza para os utilizadores finais. O fluxo abaixo é necessário apenas para autenticar o Serviço SaaS no Azure Marketplace.
Para obter mais informações sobre o Microsoft Entra ID (Ative Directory), consulte O que é autenticação.
Registar uma aplicação protegida por ID do Microsoft Entra
Qualquer aplicativo que queira usar os recursos do Microsoft Entra ID deve primeiro ser registrado em um locatário do Microsoft Entra. Este processo de registo envolve fornecer ao Microsoft Entra alguns detalhes sobre a sua aplicação. Para registrar um novo aplicativo usando o portal do Azure, execute as seguintes etapas:
Aceda ao portal do Azure.
Se a sua conta lhe der acesso a mais do que uma, selecione a sua conta no canto superior direito. Em seguida, configure a sessão no portal para o locatário desejado do Microsoft Entra.
No painel de navegação esquerdo, selecione o serviço Microsoft Entra ID, selecione Registo de aplicaçõese, em seguida, selecione Novo registo de aplicação.
Na página Criar, insira as informações de registro do seu aplicativo:
Nome: Insira um nome de aplicativo significativo
Tipos de conta suportados:
Selecione Contas apenas neste diretório organizacional (somente para um único locatário).
Quando terminar, selecione Registrar. O Microsoft Entra ID atribui um ID de Aplicativo único ao seu novo aplicativo. Você deve registrar um aplicativo que acesse a API apenase como inquilino único.
Para criar segredo do cliente, navegue até página Certificados & segredos e selecione +Novo segredo do cliente. Certifique-se de copiar o valor secreto para usá-lo em seu código.
O ID do aplicativo Microsoft Entra está associado ao ID do seu editor, portanto, certifique-se de que o mesmo ID do aplicativo seja usado em todas as suas ofertas.
Observação
Se o editor tiver duas ou mais contas diferentes no Partner Center, os detalhes de registro do aplicativo Microsoft Entra poderão ser usados em apenas uma conta. Não é suportado usar o mesmo par de ID de locatário e ID de aplicativo para uma oferta em uma conta de editor diferente.
Observação
Você deve criar o principal de serviço do aplicativo registrado no locatário que utiliza para gerar tokens. Consulte esta documentação Como criar um Service Principal para um registro de aplicativo.
Como obter o token de autorização do editor
Depois de registar a sua aplicação, pode solicitar programaticamente o token de autorização do publicador (token de acesso do Microsoft Entra, usando o endpoint do Azure AD v2). O editor deve usar esse token ao chamar as várias APIs de Atendimento SaaS. Este token é válido apenas por uma hora.
Para obter mais informações sobre esses tokens, consulte Microsoft Entra access tokens. No fluxo abaixo, é usado o token de ponto de extremidade V2.
Obter o token com um HTTP POST
Método HTTP
Publicar
URL de solicitação
https://login.microsoftonline.com/*{tenantId}*/oauth2/v2.0/token
parâmetro URI
| Nome do parâmetro | Necessário | Descrição |
|---|---|---|
tenantId |
Verdadeiro | ID do inquilino do aplicativo Microsoft Entra registrado. |
Cabeçalho da solicitação
| Nome do cabeçalho | Necessário | Descrição |
|---|---|---|
content-type |
Verdadeiro | Tipo de conteúdo associado à solicitação. O valor padrão é application/x-www-form-urlencoded. |
Corpo do pedido
| Nome da propriedade | Necessário | Descrição |
|---|---|---|
grant_type |
Verdadeiro | Tipo de subvenção. Utilize "client_credentials". |
client_id |
Verdadeiro | Identificador de cliente/aplicativo associado ao aplicativo Microsoft Entra. |
client_secret |
Verdadeiro | Segredo associado ao aplicativo Microsoft Entra. |
scope |
Verdadeiro | Recurso de destino para o qual o token é solicitado com um escopo padrão. Use 20e940b3-4c77-4b0b-9a53-9e16a1b010a7/.default porque a API SaaS do Marketplace é sempre o recurso de destino neste caso. |
resposta
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK | TokenResponse | Pedido concluído com sucesso. |
RespostaDeToken
Exemplo de resposta:
{
"token_type": "Bearer",
"expires_in": "3600",
"ext_expires_in": "0",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImlCakwxUmNxemhpeTRmcHhJeGRacW9oTTJZayIsImtpZCI6ImlCakwxUmNxemhpeTRmcHhJeGRacW9oTTJZayJ9…"
}
| Elemento | Descrição |
|---|---|
access_token |
Esse elemento é o <access_token> que você passará como parâmetro de autorização ao chamar todas as APIs de atendimento de SaaS e de medição do Marketplace. Ao chamar uma API REST segura, o token é incorporado no campo de cabeçalho da solicitação Authorization como um token "portador", permitindo que a API autentique o chamador. |
expires_in |
O número de segundos durante os quais o token de acesso continua a ser válido antes de expirar, a partir do momento de sua emissão. O momento da emissão pode ser encontrado na declaração de iat do token. |
expires_on |
O período de tempo em que o token de acesso expira. A data é expressa como o número de segundos desde "1970-01-01T0:0:0Z UTC" (corresponde à alegação exp do token). |
token_type |
O tipo de token, que é um token de acesso "Portador", o que significa que o recurso pode dar acesso ao portador desse token. |
Conteúdo relacionado
O seu aplicativo protegido por ID do Microsoft Entra agora pode usar as APIs de Subscrição de Cumprimento de SaaS Versão 2 e as APIs de Operações de Cumprimento de SaaS Versão 2 .
Tutoriais em vídeo