Skip to content

This page houses frequently asked questions about EIPs, APIs and other documentation.

EIP FAQs

Q: What is an EIP?
A: The APS Enterprise Integration Platform (EIP) is the method by which employee demographics data can be transmitted into the APS system from an external system. Both new employee records, along with updates to existing employee records, can be transmitted using the EIP.

The EIP accepts employee data via XML files created by the source system in a pre-defined format, which are then transmitted to the APS system via a multipart/form-data POST request to a secure HTTPS endpoint. Received data files are then passed through several layers of validation to minimize the risk of introducing errors into the client’s production data.

Q: Where do I find EIP documentation?
A: You can find EIP documentation by visiting this page.

Q: Are there any file type or size limitations for attachments?
A: No, we don’t enforce a limit for size through the EIP.

Q: What is the mechanism for delivery?
A: SFTP

Q: How long will it take for the documents to be fully uploaded to the SFTP server?
A: 15 minutes

Q: Where can I get access to SFTP server?
A: Please fill out this form to setup a SFTP server. Once we have finish reviewing your request, we will send an email on how to set up the SFTP server along with your credentials.

API FAQs

Q: What is an API?
A: An application programming interface (API) is code that enables two software programs to communicate

Q: Where can I find the API endpoints?
A: The API documentation can be found by visiting the API Reference page.

Q: How can I gain access?
A: Please fill out the request form to gain access.

Q: Once my access request is approved, how do I authenticate to the API?
A: Visit Authenticating to the API for complete details.

Q: What is the cost of using the API?
A: After the token access is granted, you will be billed $1.00 per employee per month.