Criar endpoints da API OAuth para clientes externos

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 2 min. de leitura
  • Crie endpoints de API OAuth para permitir que sua instância do controlador tenha comunicação bidirecional com suas instâncias de não produção. Siga e conclua cada etapa com cuidado nas instâncias especificadas antes de prosseguir para criar seus registros de provedor OAuth de terceiros.

    Antes de Iniciar

    No canto superior direito da instância, certifique-se de definir o escopo da aplicação como Global.

    Abra todas as suas instâncias (desenvolvimento, teste, produção e assim por diante) em guias separadas do navegador.

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Para criar endpoints de API do OAuth para clientes externos e usar o OAuth em seus pipelines, você deve criar vários registros, cada um em diferentes instâncias do seu pipeline. Comece em sua instância de produção, que deve ser a instância do controlador.

    Procedimento

    1. Em sua instância de produção, navegue até Tudo > OAuth de Sistema > Registro de aplicações.
    2. Selecione Novo.
    3. Selecione Criar um endpoint de API OAuth para clientes externos.
    4. No formulário, preencha os campos.
      Tabela 1. Formulário de registros de aplicações
      Campo Ação
      Nome Insira o Cliente do controlador de pipeline.
      URLs de redirecionamento
      1. Desbloqueie o campo.
      2. Insira o URL das instâncias de produção, desenvolvimento e teste, cada uma com oauth_redirect.do após a barra invertida.
      3. Bloqueie o campo.

      Separe cada um dos três URLs com uma vírgula e um espaço. Por exemplo: https://<production instance name> .service-now.com/oauth_redirect.do, https://<development instance name> .service-now.com/oauth_redirect.do, https://<test instance name> .service-now.com/oauth_redirect.do .

    5. Selecione Enviar.
      Importante:
      Conclua as próximas etapas em sua instância de desenvolvimento.
    6. Em sua instância de desenvolvimento, navegue até Tudo > OAuth de Sistema > Registro de aplicações.
    7. Selecione Novo.
    8. Selecione Criar um endpoint de API OAuth para clientes externos.
    9. No formulário, preencha os campos.
      Tabela 2. Formulário de registros de aplicações
      Campo Ação
      Nome Insira Pipeline Development Client.
      URLs de redirecionamento
      1. Desbloqueie o campo.
      2. Insira o URL das instâncias de produção e desenvolvimento, cada uma com oauth_redirect.do após a barra invertida.
      3. Bloqueie o campo.

      Separe os dois URLs com uma vírgula e um espaço. Por exemplo: https://<production instance name> .service-now.com/oauth_redirect.do, https://<development instance name> .service-now.com/oauth_redirect.do .

    10. Selecione Enviar.
      Importante:
      Conclua as próximas etapas em sua instância de teste.
    11. Em sua instância de teste, navegue até Tudo > OAuth de Sistema > Registro de aplicações.
    12. Selecione Novo.
    13. Selecione Criar um endpoint de API OAuth para clientes externos.
    14. No formulário, preencha os campos.
      Tabela 3. Formulário de registros de aplicações
      Campo Ação
      Nome Insira Cliente de teste de pipeline.
      URLs de redirecionamento
      1. Desbloqueie o campo.
      2. Insira o URL das instâncias de produção e de teste, cada uma com oauth_redirect.do após a barra invertida.
      3. Bloqueie o campo.

      Separe os dois URLs com uma vírgula e um espaço. Por exemplo: https://<production instance name> .service-now.com/oauth_redirect.do, https://<test instance name> .service-now.com/oauth_redirect.do .

    15. Selecione Enviar.
    16. Opcional: Repita este processo das etapas 11 a 15 para todas as outras instâncias de não produção (preparação e semelhantes) que você tiver.

    O que Fazer Depois

    Siga as etapas em Criar registros de provedor OAuth de terceiros nas instâncias especificadas.