Before You Begin: The Define the source details of this integration step only applies to inbound integrations.
Inbound Integrations consume information from an external system, transform the data, and transmit the file to Dayforce. Start by importing the swagger of the source API. On import, Integration Studio analyzes the swagger and generates options in the Create Retrieval Request and Read Data tabs.
For example, Integration Studio would generate /executeGETSTATUS in the Create data retrieval request API drop-down list if it is a defined path in the swagger. Once selected, populate the required headers, query parameters, and authentication details for the source API.
Similarly, Integration Studio will generate options for Top Level Field and Main Data Array under the Read Data tab. These two required fields allow Integration Studio to read and interpret the API response. For Top Level Field, select the root, or other highest-level field, in the expected response. Next, select the name of the array which contains the data you need to map in the Main Data Array drop-down list.
When you are configuring an integration that uses the Build My Own (Inbound File) connector, you can provide a private PGP key and a passphrase to decrypt your source data if it is encrypted. This is done by entering a private PGP key into the Private PGP Key field and then a passphrase into the Passphrase field.
As you are going through the Define the source details of this integration step, refer to Define the transmission details of this integration, because the information in this topic outlines what is required.