Step 6: Register API Client (Workday)
To establish a secure and functional connection between FISPAN Sync and Workday, you must register an API client within your Workday environment. This process generates unique and secure credentials (Client ID and Client Secret) that serve as the connection's identity, allowing it to access required Workday data safely and with the proper authorization.
Follow these steps to register an API client in Workday.
Open Register API Client
In Workday’s search field, type Register API Client and select the task from the results.
Enter API Client Details
Once the task opens, enter the following details:
- Client Name: Enter a descriptive name, such asFISPAN Integration.
NOTE: We recommend the name FISPAN Integration. You can use a different name, such as one that includes your bank’s name, as long as you can easily identify the API client in Workday.
- For Client Grant Type, select the Authorization Code Grant option.
- For Access Token Type, select the Bearer option.
- For Redirection URI, use the following, dependent on if you are setting up for Sandbox for Production:
Environment | Redirection URI |
|---|---|
Sandbox | https://sandbox.fispan.cloud/api/identity/callback |
Production | https://sys.fispan.live/api/identity/callback |
NOTE: Not sure which environment you’re setting up? Check the address bar in the installation wizard and use the Redirection URI that starts with the same address.
- Refresh Token Timeout: Select the Non-Expiry Refresh Tokens option.
TIP: Selecting a non-expiry token simplifies maintenance by eliminating the need for manual re-authentication or reconfiguration upon token expiration. This ensures a continuous, uninterrupted integration.
- Scope (Functional Areas): Search for and select the following:
- Banking and Settlement
- Staffing
- Supplier Accounts
- Suppliers
- System
- Tenant Non-Configurable
TIP: The Workday "Scopes" search can be tricky! The best approach is to type in the text from each item above and hit enter, which will select this specific permission by name. Repeat for each item.
- Include Workday Owned Scope: Ensure this checkbox is selected.
Click OK to generate your unique Client ID, Client Secret, WORKDAY REST API Endpoint, Authorization Endpoint, and Token Endpoint.
Secure API Client Credentials
Workday will generate and display a handful of values for you.
IMPORTANT: Treat the Client ID and Client Secret like passwords. Workday shows the Client Secret only once. Keep this page open until you finish connecting in the installation wizard, or you may need to start again.
Copy Your Credentials
Next, paste values from this screen into the FISPAN Onboarding Wizard into the corresponding fields. Workday generates the following values:
- Client ID
- Client Secret
- Workday REST API Endpoint
- Authorization Endpoint
- Token Endpoint
Copy each value and paste it into the matching field in the installation wizard.
Once complete, click Next Step in the installation wizard to save your credentials.