Conceito: API REST do Adaptive Planning

Um cliente invoca uma chamada de API enviando uma solicitação HTTP POST para o ponto de extremidade principal de serviços Web do Adaptive Planning . O ponto de extremidade inclui um número de versão que indica a versão da API em uso. A versão atual da API do Adaptive Planning é a v40.

As versões de API geralmente são atualizadas com novas versões de produtos do Adaptive Planning , embora nem todas as versões de produtos resultem em uma nova versão de API. O Workday oferece suporte à versão atual por pelo menos um ano após o lançamento da versão de API subsequente.

Para obter um histórico de alterações de API, consulteAlterações de API por versão .

A solicitação HTTP POST contém dados de publicação em um documento XML. Esse documento XML inclui seções padrão presentes em todas as chamadas de método de API e seções específicas para cada chamada de método de API. O servidor do Adaptive Planning processa a chamada de método da API e retorna os resultados como outro documento XML. Assim como a solicitação, o documento XML de resposta inclui seções iguais para cada método de API e seções específicas para cada método de API.

Toda recuperação de dados usa uma pesquisa. O chamador especifica critérios para corresponder a vários elementos, e o servidor responde com uma lista de entidades de metadados ou dados que correspondem aos critérios. A criação e a atualização de dados usam um carregamento em massa de dados, também enviados por meio de uma diretriz POST.

Todas as solicitações de API são criptografadas porque devem usar o protocolo da Web HTTPS. As credenciais de autenticação do usuário são transmitidas ao Adaptive Planning como parte do corpo da solicitação de serviços Web. Isso significa que a camada da Web criptografa a ID de logon e a senha de um usuário antes que ele saia do computador que gera a solicitação de serviços Web e a descriptografa somente quando o servidor de destino as recebe.

Autenticar um usuário em uma solicitação de API não cria uma sessão persistente para esse usuário; cada chamada de serviço Web separada deve autenticar seu usuário separadamente.

Além disso, os métodos de serviço Web restringem a saída de cada chamada ao conjunto de dados visível para o usuário que faz a solicitação. Exemplo: o método de serviço Web exportData limita os dados retornados aos dados encontrados nos níveis que o usuário responsável pela chamada possui.