Configurar o acesso à API no Partner CenterSet up API access in Partner Center

Aplica-se a:Applies to:

  • Partner CenterPartner Center
  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany

Este artigo descreve as contas que você precisa desenvolver em relação ao SDK da Central de Parceiros.This article describes the accounts you need to develop against the Partner Center SDK. Este artigo também explica como criar uma conta de área restrita de integração e testá-la na área restrita de integração.This article also explains how to create an integration sandbox account and test in the integration sandbox.

Observação

Para obter acesso às APIs, seu locatário precisa ser um locatário do CSP e você precisa ser um provedor indireto ou um parceiro de cobrança direto.To get access to APIs, your tenant must be a CSP tenant and you must be either an indirect provider or a Direct bill partner.

Definições de contaAccount definitions

Para ajudar você a integrar e testar a integração de API, o Partner Center oferece suporte a dois tipos de contas:To help you integrate and test your API integration, Partner Center supports two kinds of accounts:

Conta principal do Partner CenterPrimary Partner account

Nessa conta, você cria pedidos reais para clientes reais.This account is where you create real orders for real customers. Se você fizer alterações ou transações quando estiver conectado à conta principal, usando o SDK do Partner Center ou a interface do usuário do Painel do Partner Center, elas serão tratadas como pedidos oficiais para clientes de verdade.If you make any changes or transactions when you are signed in to the primary account, by using either the Partner Center SDK or the Partner Dashboard UI, they will be treated as official orders for real customers. Eles serão refletidos em sua fatura, e sua empresa é responsável por pagá-los.They will be reflected in your invoice, and your company is responsible for paying for them.

Conta da área restrita de integraçãoIntegration sandbox account

Essa conta serve para testar seu código e sua integração com as APIs do Partner Center antes de implantá-lo amplamente.This account is for testing your code and its integration with the Partner Center APIs before you deploy it broadly. As alterações e transações que você faz quando está conectado à conta da área restrita de integração aparecem em sua fatura. No entanto, você não precisa pagar o valor da fatura.Changes and transactions you make when you are signed into the integration sandbox account will appear in your invoice, however, you do not have to pay the invoice amount. O PDF da fatura terá um aviso de isenção de responsabilidade como "NÃO PAGUE.Invoice pdf will have a disclaimer as "DO NOT PAY. ESTA É UMA FATURA DE ÁREA RESTRITA E NÃO É NECESSÁRIA NENHUMA AÇÃO."THIS IS A SANDBOX INVOICE AND NO ACTION IS REQUIRED."

A conta da área restrita de integração e a conta principal atuam de forma independente e não compartilham contas de administrador, contas de usuário, clientes, pedidos, assinaturas ou outros dados.The integration sandbox account and the primary account act independently, and do not share admin accounts, user accounts, customers, orders, subscriptions, or other data.

A área restrita de integração dá suporte a transações com um número limitado de clientes, pedidos, assinaturas, licenças etc.The integration sandbox supports transactions with a limited number of customers, orders, subscriptions, licenses, etc.

Pela política, as contas da área restrita de integração servem somente para fins de teste de integração.By policy, integration sandbox accounts are for integration testing purposes only.

Por padrão, não há nenhuma conta da área restrita de integração configurada.By default, there is no integration sandbox account. Você deverá criar uma sozinho se quiser usar o SDK do Partner Center.You must create one yourself if you plan to use the Partner Center SDK.

Configurar suas contasSet up your accounts

Esta seção descreve como configurar uma conta principal do Partner Center e uma conta de área restrita de integração para o SDK do Partner Center.This section describes how to set up a primary Partner account and an integration sandbox account for the Partner Center SDK.

Criar uma área restrita de integraçãoCreate an integration sandbox

  1. Entre no Painel do Partner Center com uma conta do administrador global (sua conta principal do Partner Center).Sign in to Partner Dashboard with a global admin account (your primary Partner account.)

  2. No menu Configurações (ícone de engrenagem), escolha Configurações do parceiro.From the Settings menu (gear icon), choose Partner settings.

  3. Escolha a guia Área restrita de integração.Choose Integration sandbox tab.

    Observação

    Se você não vir uma opção de área restrita de integração, talvez você não tenha uma conta do administrador global.If you don't see an Integration sandbox option, you might not have a global admin account. Também é possível que você esteja usando uma conta de área restrita de integração quando uma área restrita de integração já foi configurada.You also might be using an integration sandbox account and an integration sandbox has already been set up.

  4. Insira as informações de contato da conta do administrador da área restrita de integração.Enter the contact information for the integration sandbox admin account. Em seguida, escolha Criar conta.Then, choose Create account. Aguarde alguns minutos para receber uma mensagem de confirmação de que a conta foi criada.Wait a few minutes for a confirmation message that the account has been created.

  5. Depois de ver a mensagem de confirmação, saia do Painel do Partner Center.After you see the confirmation message, sign out of Partner Dashboard.

  6. Entre novamente com sua nova conta do administrador da área restrita da integração.Sign back in with your new integration sandbox admin account. É preciso que você use o formato **username@domain** para suas credenciais junto com a senha que você acabou de especificar.Be sure to use the format **username@domain** for your credentials along with the password that you just specified.

  7. Escolha Configurar a Conta acima de Tarefas Atuais para concluir a configuração da conta de área restrita.Choose Set Up Account above Current Tasks to complete the sandbox account setup.

Habilitar o acesso à APIEnable API access

Depois que sua conta for configurada, você deve habilitar o acesso à API antes de poder usar o SDK do Partner Center com a área restrita de integração.After your account is set up, you must enable API access before you can use the Partner Center SDK with the integration sandbox. Você precisa permitir o acesso à API separadamente para sua conta principal do Partner Center e sua conta da área restrita de integração.You need to enable access to the API separately for both your primary Partner account and your integration sandbox account.

  1. Entre no Painel do Partner Center usando uma conta do administrador global.Sign into Partner Dashboard using a global admin account.

  2. No menu Configurações (ícone de engrenagem), selecione Configurações do parceiro.From the Settings menu (gear icon), select Partner settings.

  3. Na página Configurações da conta, escolha Gerenciamento de aplicativos.On the Account settings page, choose App management.

  4. Se você ainda não tiver um aplicativo existente, adicione um novo aplicativo Web.If you do not already have an existing app, add a new web app. Se você tiver um aplicativo Web existente, escolha o botão Adicionar chave.If you have an existing web app, choose the Add key button.

  5. Copie as informações de registro do aplicativo (especialmente a Chave, caso você esteja criando um aplicativo Web) e, em seguida, armazene-as em um local seguro.Copy the app registration information, especially the Key if you're creating a web app, and store it in a safe place.

  6. Saia do Painel do Parceiro.Sign out of Partner Dashboard.

  7. Entre novamente com sua conta da área restrita de integração.Sign back in with your integration sandbox account. Repita as etapas 2 a 5 para habilitar o acesso à API na área restrita de integração.Repeat steps 2-5 to enable API access in the integration sandbox.

Escrever e testar códigoWrite and test code

Você pode escrever código e testá-lo na área restrita de integração.You can write code and test code in the integration sandbox. Você precisará das informações a seguir para configurar a autenticação do Partner Center com o Azure AD.You'll need the following information to set up Partner Center authentication with Azure AD.

Nome do itemItem name Local do itemItem location
ID do aplicativo/ID do clienteApp ID / Client ID No menu Configurações (ícone de engrenagem), selecione Configurações do parceiro.From the Settings menu (gear icon), select Partner settings. Na página Configurações da conta, selecione Gerenciamento de Aplicativos.On the Account settings page, select App Management. A ID do aplicativo/ID do cliente está listada como a ID do aplicativo de um aplicativo registrado.The App ID/Client ID is listed as the Registered application App ID.
ChaveKey Se você criou um aplicativo Web na seção Habilitar o acesso à API, essa é a chave que você salvou na etapa 5.If you created a web app in the section Enable API access, this is the key that you saved in step 5.
DomínioDomain O domínio para a área restrita de integração.The domain for the integration sandbox.

Executar código testadoRun tested code

Para usar sua solução com dados de clientes reais, você deve alterar suas credenciais de área restrita de integração para suas credenciais de conta principal do Partner Center.To use your solution with real customer data, you must change from your integration sandbox credentials to your primary Partner account credentials.

Quando estiver pronto para usar o código testado em sua conta principal do Partner Center, você precisará obter um token de segurança do Azure AD.When you're ready to use your tested code in your primary Partner account, you must get an Azure AD security token. Esse token de segurança é baseado em seu aplicativo, chave e domínio do Partner Center (em vez de seu aplicativo, chave e domínio da área restrita de integração).This security token is based on your Partner Center app, key and domain (instead of your integration sandbox app, key and domain).

  1. Siga as etapas em Autenticação do Partner Center para obter um token de segurança do Azure AD usando suas credenciais principais do Partner Center.Follow the steps in Partner Center authentication to get an Azure AD security token using your primary Partner Center credentials. (Você seguiu essas etapas anteriormente para obter um token de segurança do Azure AD para sua área restrita de integração.)(You previously followed these steps to get an Azure AD security token for your integration sandbox.)

  2. Substitua o token de segurança de integração em seu código pelo novo token de segurança para sua conta principal do Partner Center.Replace the integration security token in your code with the new security token for your primary Partner account.