Fim do suporte para Authtokens e modelo URI na API REST

O End Of Life para Authtokens já esta em vigor desde o final de fevereiro de 2021, mas ainda surge muitas dúvidas sobre o tema:

O que devo fazer?

OAuth é o protocolo padrão da indústria para autenticação de cliente e recomendamos que nossos usuários migrem para o OAuth. Várias integrações e recursos no ServiceDesk Cloud que usavam Authtoken no passado foram atualizados para usar OAuth agora.

Se você estiver usando qualquer um dos recursos/integração mencionados na tabela abaixo, execute a ação recomendada para mudar para o OAuth o mais rápido possível. Isso garantirá o funcionamento perfeito dos recursos e integrações relevantes.

	Recurso / integração em uso	Ação recomendada	Comentários
1	Integração com Desktop Central	Atualize a versão do Desktop Central para 100598 ou superior.   Baixe os service packs do DesktopCentral aqui . Integre-se novamente ao ServiceDesk Plus Cloud seguindo as instruções disponíveis aqui .	Versões mais antigas do Desktop Central usam authtoken e a integração parará de funcionar se a compilação não for atualizada.   Para obter ajuda na atualização, entre em contato com desktopcentral-support@manageengine.com
2	Ferramenta de provisionamento	Localize a máquina onde a ferramenta de provisionamento está configurada para ser executada como uma tarefa agendada no Agendador de tarefas do Windows Clique duas vezes e execute a ferramenta de provisionamento Clique em Autorizar e siga as instruções mostradas para abrir um navegador e Autorizar. [Ignore esta etapa se o botão Autorizar estiver no estado desativado / esmaecido] Prossiga para as próximas etapas na ferramenta de provisionamento Verifique as configurações da ferramenta de aprovisionamento e veja se os usuários que foram adicionados, excluídos ou desabilitados estão corretos Clique em “Salvar configurações para sincronização” na tela final e salve o sync.conf Vá para o Windows Task Scheduler e localize a tarefa agendada que executa a ferramenta Provisioning Verifique os argumentos fornecidos para a ferramenta de provisionamento e descubra a localização do sync.conf usado Sobrescrever o sync.conf presente nesse local também Por exemplo, se você estiver usando o sync.conf colocado na pasta C: \ ManageEngine e se você estiver usando este sync.conf no agendador de tarefas do Windows, por favor, substitua este arquivo sync.conf também	Você deve substituir o arquivo sync.conf usado no Windows Task Scheduler
3	Integração do ManageEngine Applications Manager	Faça upgrade para o Applications Manager Build 14410 ou superior.   Você pode baixar os pacotes de serviço do gerenciador de aplicativos aqui .   Habilite a integração usando OAuth. Siga as instruções disponíveis em “Usando OAuth”.	Para qualquer assistência, entre em contato com appmanager-support@manageengine.com
4	Chamando nossas APIs de funções personalizadas disponíveis no ServiceDesk Plus Cloud	Use zoho.sdp.invokeurl (ou) Configure e use Connections. As conexões podem ser configuradas em Configuração >> Espaço do desenvolvedor >> Conexões .	Verifique se você está chamando alguma chamada SDP Cloud API usando authtoken em qualquer uma das funções personalizadas. Se authtoken for usado, altere a chamada de API para usar zoho.sdp.invokeurl (ou) Conexões. Consulte o documento de ajuda com link abaixo para obter mais detalhes:   Documento de Ajuda de Conexões
5	Chamando nossas APIs de produtos de terceiros	Modifique as APIs para usar OAuth   Consulte aqui para obter mais detalhes sobre como usar o OAuth
6	Chamando nossas APIs usando seus próprios programas ou scripts	Modifique seu programa ou script para usar OAuth.   Consulte aqui para obter mais detalhes sobre como usar o OAuth
7	Versões mais antigas de aplicativos iOS e Android	Atualize para as versões mais recentes de nossos aplicativos na App Store / Play Store

Suspenso modelo URI:

Na versão SDP Cloud v3 das APIs REST, oferecemos suporte a operações especiais que podem ser chamadas sobre entidades. Por exemplo, a operação de pickup em uma solicitação nada mais é do que uma operação de edição em que apenas o campo técnico é atualizado. Tradicionalmente, os usuários devem invocar a API de edição da solicitação e passar o ID do usuário atual. No SDP Cloud, oferecemos suporte a uma URL especial para essas operações de conveniência. As operações podem ser realizadas acessando os URIs,

1. / api / v3 / requests / <id> / assign
2. / api / v3 / requests / <id> / _assign

Aqui, a ” atribuição ” no final é a operação de conveniência. Como você pode ver, a diferença entre os dois URIs é o sublinhado presente no início do token de atribuição. Este sublinhado (‘_’) ajuda a identificar o nome da operação chamada.

Estamos descontinuando os URIs de operações ambíguas sem sublinhado. O suporte para esses URIs será removido após 15 de janeiro de 2021. Qualquer URL inválido que for acessado após a data mencionada anteriormente retornará um código de erro 404.

DICA PRO: SDP Cloud APIs tem HATEOAS implementado como um componente principal. Simplificando, o HATEOAS fornece uma maneira padrão para os clientes descobrirem as ações e operações oferecidas por um recurso / entidade. O HATEOAS sempre retornará operações para as quais um usuário possui autorização. Isso elimina a necessidade dos clientes de verificar se uma determinada operação é permitida para um usuário.

HATEOAS para uma entidade / recurso pode ser acessado com o seguinte URI,

1. / api / v3 / <resource-name> / _links
2. / api / v3 / <resource-name> / <id> / _links

Abaixo está um exemplo de resposta do HATEOAS da operação _links para a entidade “request”. A seção de links fornece os detalhes das operações como o nome exclusivo da operação, o método HTTP a ser usado, bem como a URL (href) a ser chamada. Recomendamos que os usuários identifiquem a operação por seu nome e busquem o URL

1. {
2.  “response_status”: [{
3.   “status_code”: 2000,
4.   “status”: “sucesso”
5.  }],
6.  “_links”: [{
7.   “método”: “postar”,
8.   “non_editable_fields”: [],
9.   “nome”: “adicionar”,
10.   “href”: “/ pedidos”
11.  }, {
12.   “método”: “colocar”,
13.   “nome”: “pickup”,
14.   “href”: “/ requests / _pickup”
15.  }, {
16.   “método”: “colocar”,
17.   “nome”: “fechar”,
18.   “href”: “/ requests / _close”
19.  }]
20. }

Entendemos que essas mudanças podem interromper suas operações, mas recomendamos que você veja isso como uma oportunidade para melhorar seu jogo de segurança e fornecer um suporte melhor e mais seguro a todos os seus clientes.

ACS Pro Parceira ManageEngine no Brasil. – Fone / WhatsApp (11) 2626-4653.

[wptelegram-ajax-widget widget_width=”300″ widget_height=”200″]

PodCafé da TI – Podcast, Tecnologia e Cafeína. [podcast_subscribe id=”10553″]