使用 Workday 凭据发出 Adaptive Planning API 请求

先决条件

确认需要 API 访问权限的 ISU 用户是否属于
“Set Up: Adaptive Planning API Access”
安全域。

验证是否已在
“User Sign-on”
选项卡中启用
“Single Sign-On
”任务。
Adaptive Planning
选项卡
确认已在
“Public API”
选项卡中启用
“Public API
setup”任务。
Adaptive Planning
选项卡
验证集成系统用户 (ISU) 设置任务是否创建了专门用于发出 Workday Adaptive Planning API 请求的 ISU，并将其映射到
Adaptive Planning
用户帐户

确认您是否看到开头为
PublicAPIISU_
位于“管理”>“用户”的用户列表中。
确认此用户是否具有其要运行的 API 所需的层级访问权限。默认情况下，新的集成系统用户不会获得层级访问权限。

步骤

获取证书并提取公钥。
使用该证书在 Workday 中注册 API 客户端。
生成 JWT 令牌，检索 Workday access_token，然后检索 AdaptiveAPIAccessToken。
在中使用 AdaptiveAPIAccessToken
Adaptive Planning
API Request

获取证书并提取公钥

从您的证书中提取公钥，以便上传到 Workday。
请保留您的私钥，以便在调用应用程序中使用。
注册 JWT 不记名令牌时，请将证书粘贴到 Workday 中。在脚本中引用您的私钥。

注册 Workday API 客户端

在 Workday 中注册
客户端授权类型为“Jwt Bearer Grant”
的 API 客户端。有关更多信息，请参见 注册 API 客户端 。
在 Workday 的“注册 API 客户端”页面中，将为您的证书派生的公钥复制到
x.509 证书
中。
对于
“Scope (Functional Area)”，
选择
Adaptive Planning
。
完成 API 客户端注册后，请将页面底部的字段复制到文本文件中以供稍后使用。
Workday REST API 端点
令牌端点
授权端点

生成 JWT 令牌、检索 Workday access_token 和检索 AdaptiveAPIAccessToken

使用您的私钥，并通过运行下列伪代码生成 JWT 令牌。

要检索 Workday 访问令牌，请创建

POST

向令牌端点发送请求，传递

grant_type

和

assertion

。使用在 Workday 中注册 API 客户端后复制的令牌端点。令牌端点示例：

https://{host or gateway}/ccx/oauth2/{tenant}/token

示例

CURL

向令牌端点发出请求

curl --request POST 'https://{host or gateway}/ccx/oauth2/{tenant}/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer' \
--data-urlencode 'assertion={{the jwt assertion from your certificate}}'

使用 Workday 访问令牌调用 Workday 端点，以检索 AdaptiveAPIAccessToken。使用先前的

access_token

value 作为 Bearer 令牌

Auth

此字段的标头

GET.

访问令牌示例：

https://{host or gateway}/ccx/api/planning/v1/{tenant}/adaptiveAPIAccessToken

示例

CURL

请求 AdaptiveAPIAccessToken：

curl --request GET 'https://{host or gateway}/ccx/api/planning/v1/{tenant}/adaptiveAPIAccessToken' \
--header 'Authorization: Bearer {{the prior access_token value}}' \
--data-raw ''

调用

Adaptive Planning

在 HTTP 请求的 XML 文件的凭据元素中使用 AdaptiveAPIAccessToken 的 API

POST

。示例：

curl -H "Content-Type: text/xml" -d '<?xml version='1.0' encoding='UTF-8'?><call method="exportLevels" callerName="a string that identifies your client application"><credentials token="ID eyJhbDci0iJSUzUxMiIsUmtpZCI6IdvcmtkYXlfa2V5In0.eyJpc3KiOiJXb3JrZGFZIiwiYXV0aF90aW1lIjoxNTczMTY3NjU2LBjzeXnfynnJd.bztQzBmHeTj1amnHA-r96TdrJK0MXMghUFF1KyjxqIq6ruHU63dJp3JAJn3Eche7SEcoZBVGX4wJgna106pmCqgrrVWMf13Hg_sb_szabal2XN1KEEk1qh8z1IDlbt6qJIL_xyW3J2nNSs5ima3vJUYU5sRQXwXst0GuFWXpy464GyB4oKcscrg28X3dnPO_ytdohMKHsWkqyHQKXFQwoQezFaGy10sp4RRUj0lpOZX8C9oBHDYA58IXxGkqKLJVNPvDND6rGY5fTHQ-yxpe1nz-WqB0boiq9a-dv8b3EBzbelxj2fCPdMbng6kzygDcA2at_7BNQiyzfIovS5AG"/><include versionID="3" inaccessibleValues="false"/><sheet id="3" /></call>' -X POST https://api.adaptiveplanning.com/api/v23

用于生成 JWT 令牌的 Java 应用程序示例

//**********************************************************************
//
// File: TestPublicAPISample.java
//
// Copyright 2004-2019 Workday Adaptive Planning.
// All Rights Reserved.
//
// This work contains trade secrets and confidential material of
// Workday Adaptive Planning and its use or disclosure in whole or in part
// without the express written permission of Workday Adaptive Planning is prohibited.
//
//**********************************************************************



import java.io.FileInputStream;
import java.security.KeyStore;
import java.security.PrivateKey;
import java.security.Signature;
import java.text.MessageFormat;
//import java.util.Base64;

import org.apache.commons.codec.binary.Base64;



   public class AccessAdaptiveAPI
   {
       public static void main(String args[])
       {
           String jwtKeyStoreFileString = "/Library/Java/JavaVirtualMachines/jdk1.8.0_172.jdk/Contents/Home/jre/lib/security/JWTkeystore.jks";
           String clientIDString = "BlywNDM1NmMtZTk2Mi00NTZiTWEyZjktZWM1NGJiOGQ3Yjca";
           String userIdString = "PublicAPIISU_Test";
           
           System.out.println(GetAccessToken(clientIDString,userIdString,jwtKeyStoreFileString));
       }
       
       public void callAPI()
       {
           
       }
       
       public String getAdaptiveAPIToken()
       {    
           return "";
       }
       
       public String getJWTToken(String privateKey, String username)
       {    
           return "";
       }
       
       public void callWorkdayAPI()
       {
           
           
       }
       
       public static String GetAccessToken(String clientId, String userId, String jwtKeyStore) {

           String header = "{\"alg\":\"RS256\",\"typ\":\"JWT\"}";
           String claimTemplate = "'{'\"iss\": \"{0}\", \"sub\": \"{1}\", \"aud\": \"{2}\", \"exp\": \"{3}\"'}'";


           try {
               StringBuffer token = new StringBuffer();

               //Encode the JWT Header and add it to our string to sign
               token.append(Base64.encodeBase64URLSafeString(header.getBytes("UTF-8")));

               //Separate with a period
               token.append(".");


               //Create the JWT Claims Object
               String[] claimArray = new String[4];
               //iss
               claimArray[0] = clientId;
               //sub
               claimArray[1] = userId;
               //aud
               claimArray[2] = "wd";
               //exp
               claimArray[3] = Long.toString( ( System.currentTimeMillis()/1000 ) + 300);
               MessageFormat claims;
               claims = new MessageFormat(claimTemplate);
               String payload = claims.format(claimArray);

               //Add the encoded claims object
               token.append(Base64.encodeBase64URLSafeString(payload.getBytes("UTF-8")));
               //token.append(Base64.encodeBase64URLSafeString(payload.getBytes("UTF-8")));

               //Load the private key from a keystore
               KeyStore keystore = KeyStore.getInstance("JKS");
               keystore.load(new FileInputStream(jwtKeyStore), "Workday123!".toCharArray());
               PrivateKey privateKey = (PrivateKey) keystore.getKey("Workday", "Workday123!".toCharArray());

               //Sign the JWT Header + "." + JWT Claims Object
               Signature signature = Signature.getInstance("SHA256withRSA");
               signature.initSign(privateKey);
               signature.update(token.toString().getBytes("UTF-8"));
               String signedPayload = Base64.encodeBase64URLSafeString(signature.sign());

               //Separate with a period
               token.append(".");

               //Add the encoded signature
               token.append(signedPayload);
               return token.toString();
               //System.out.println(token.toString());

           } catch (Exception e) {
               e.printStackTrace();
           }
           return "";
       }
   }

用于生成 JWT 令牌的 C# 应用程序示例

           var clientId = "BlywNDM1NmMtZTk2Mi00NTZiTWEyZjktZWM1NGJiOGQ3Yjca";//Client ID from workday API Client
           var isu = "PublicAPIISU_Test"; //the ISU
           var timeout = (DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() / 1000 + 300).ToString(CultureInfo.InvariantCulture);
           var environment = "wd";
           var pfxFilePath = @"C:\temp\JWTkeystore2.pfx";
           var pfxPassword = "Workday123!";

           var payload = new JwtPayload
           {
               {"iss", clientId},
               {"sub", isu},
               {"aud", environment},
               {"exp", timeout },
           };

           var signingCredentials = new X509SigningCredentials(new X509Certificate2(pfxFilePath, pfxPassword), SecurityAlgorithms.RsaSha256); // the matching PKCS #12 file with private key
           var jwtHeader = new JwtHeader(signingCredentials);

           var secToken = new JwtSecurityToken(jwtHeader, payload);
           var handler = new JwtSecurityTokenHandler();
           var tokenToWorkday = handler.WriteToken(secToken);
           Console.WriteLine(tokenToWorkday);

在中使用 AdaptiveAPIAccessToken

Adaptive Planning

API 请求

示例 AdaptiveAPIAccessToken

Adaptive Planning

API 请求

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLevels" callerName="a string that identifies your client application">
   <credentials token="ID eyJhbDci0iJSUzUxMiIsUmtpZCI6IdvcmtkYXlfa2V5In0.eyJpc3KiOiJXb3JrZGFZIiwiYXV0aF90aW1lIjoxNTczMTY3NjU2LBjzeXnfynnJd.bztQzBmHeTj1amnHA-r96TdrJK0MXMghUFF1KyjxqIq6ruHU63dJp3JAJn3Eche7SEcoZBVGX4wJgna106pmCqgrrVWMf13Hg_sb_szabal2XN1KEEk1qh8z1IDlbt6qJIL_xyW3J2nNSs5ima3vJUYU5sRQXwXst0GuFWXpy464GyB4oKcscrg28X3dnPO_ytdohMKHsWkqyHQKXFQwoQezFaGy10sp4RRUj0lpOZX8C9oBHDYA58IXxGkqKLJVNPvDND6rGY5fTHQ-yxpe1nz-WqB0boiq9a-dv8b3EBzbelxj2fCPdMbng6kzygDcA2at_7BNQiyzfIovS5AG"/>
   <include versionID="3" inaccessibleValues="false"/>
   <sheet id="3" />
</call>