Configurar a coleção Postman para o Serviço de Crédito Ambiental (Versão Preliminar)

Importante

Algumas ou todas estas funcionalidades estão disponíveis como parte de uma versão preliminar. O conteúdo e a funcionalidade estão sujeitos a alterações. Você pode acessar o ambiente de área restrita do Serviço de Crédito Ambiental (versão preliminar) para uma avaliação de 30 dias. Para usar o Serviço de Crédito Ambiental (Versão Preliminar) em um ambiente de produção, preencha o Formulário de inscrição do Serviço de Crédito Ambiental (Versão Preliminar).

Você pode copiar a coleção Postman e alterar os parâmetros, conforme necessário.

Integração ao Serviço de Crédito Ambiental (Versão Preliminar) como um aplicativo próprio em seu locatário do Azure AD

Para autenticar com o Serviço de Crédito Ambiental (Versão Preliminar), os usuários de seu diretório devem apresentar um token de autenticação, particularmente um token da Web JSON, com algumas declarações necessárias. Essas reivindicações ajudarão o Serviço de Crédito Ambiental (Versão Preliminar) a identificar o acesso fornecido a um usuário.

Nota

Como o Serviço de Crédito Ambiental (Versão Preliminar) é um aplicativo de terceiros da Microsoft, você não pode excluí-lo de seu locatário após implantá-lo.

  1. Verifique se você tem acesso para implantar Serviço de Crédito Ambiental (Versão Preliminar) em seu locatário.

    Navegue até Portal do Azure > Azure Active Directory > Configurações do usuário e verifique a propriedade Os usuários podem registrar aplicativos. Se estiver definida como Não, entre em contato com um dos administradores de locatário do Azure AD para configurar o Serviço de Crédito Ambiental (Versão preliminar) de seu locatário.

  2. Você também pode precisar dessa permissão para registrar qualquer cliente ou aplicativo Web em seu locatário, com base no cenário aplicável para sua equipe.

  3. Siga as etapas em Conectar-se com o módulo Azure Active Directory PowerShell for Graph. Estas etapas configurarão o módulo Azure AD PowerShell e se conectarão ao seu locatário do Azure AD usando uma identidade que tenha as permissões especificadas na primeira etapa.

  4. Para implantar o Serviço de Crédito Ambiental (Versão Preliminar) em seu locatário, use este comando do PowerShell, especificando seu módulo Azure AD PowerShell:

       New-AzureADServicePrincipal -AppId "b9b0ac19-f710-429d-b58e-dc3f73a330a9" -DisplayName "Environmental Credit Service"
    
  5. Depois que o Serviço de Crédito Ambiental (Versão Preliminar) for implantado em seu locatário, navegue até Portal do Azure > Azure Active Directory > Aplicativos Empresariais > Escolher Aplicativos Microsoft para o tipo de Aplicativo (e Aplicar). Pesquise por Serviço de Crédito Ambiental (Versão preliminar) para visualizar o aplicativo corporativo implantado.

Configurar a coleção Postman

Para configurar a coleção Postman para o Serviço de Crédito Ambiental (Versão preliminar), siga esta etapa única para cada locatário do Azure AD que você usa que interagiria com o Serviço de Crédito Ambiental (Versão Preliminar):

  1. Registre um aplicativo cliente público no locatário navegando para Portal do Azure > Azure Active Directory > Registros de aplicativos > Novo registro. Insira os seguintes valores:

    • Nome: forneça um nome de exibição válido para o usuário.
    • Tipos de conta com suporte: escolha a opção Contas apenas neste diretório organizacional porque o aplicativo não autenticará contas de usuário fora deste locatário.
    • Nenhum URI de redirecionamento é esperado neste caso.
  2. Selecione Autenticação. Em Configurações avançadas, defina Tratar aplicativo como um cliente público como Sim. Salve suas alterações. Os aplicativos clientes públicos permitem que os usuários se autentiquem usando fluxos de trabalho móveis ou de desktop e coletem senhas de texto sem formatação usando um fluxo de trabalho de credencial de senha do proprietário do recurso.

  3. Selecione a seção Manifesto. No editor JSON, procure a propriedade accessTokenAcceptedVersion e defina seu valor como 2. Selecione Salvar para aplicar as alterações.

  4. Nesse cenário, o cliente público tenta usar o token do usuário conectado para acessar as APIs do Serviço de Crédito Ambiental (Versão preliminar). O aplicativo deve solicitar a permissão delegada Application.ReadWrite conforme exposto pelo aplicativo empresarial Serviço de Crédito Ambiental (Versão preliminar) registrado na seção de pré-requisito:

    1. Navegue até o aplicativo registrado, selecione Permissões de API e escolha Adicionar uma permissão.
    2. Selecione a guia APIs que minha organização usa e procure o aplicativo empresarial Serviço de Crédito Ambiental (Versão preliminar) que foi implantado no locatário durante as etapas de pré-requisito.
    3. Selecione Permissões delegadas. As permissões delegadas exigem consentimento único do usuário para indicar que o aplicativo pode usar seu token para acessar o recurso necessário. Como esse cenário envolve um fluxo de trabalho não interativo, o consentimento precisa ser concedido antecipadamente pelo administrador do locatário para as permissões delegadas necessárias.

Após a configuração das permissões delegadas, você pode solicitar o token de acesso de forma não interativa usando os detalhes fornecidos na Solicitação de autorização.

O valor da propriedade do escopo na solicitação de token de acesso deve ser igual ao escopo Application.ReadWrite: https://ecs.mcfs.microsoft.com/Application.ReadWrite. A chamada para o ponto de extremidade de token pode ser iniciada antes de atingir qualquer API do Serviço de Crédito Ambiental (Versão preliminar).

Depois que a autenticação estiver funcionando, atualize as seguintes variáveis de coleção do Postman:

  1. Defina as variáveis de ID do cliente para a propriedade de ID do aplicativo dos aplicativos clientes públicos registrados nos respectivos locatários Azure AD, conforme descrito nas etapas anteriores.

  2. Atualize o nome de usuário (email) e a senha, conforme necessário para as variáveis disponíveis na coleção Postman.

Confira também

Visão Geral do Serviço de Crédito Ambiental (Versão Preliminar)
Glossário do Serviço de Crédito Ambiental (Versão Preliminar)
Visão geral da referência de API do Serviço de Crédito Ambiental (Versão Preliminar)