Software partners
This page contains documentation designed to help our software partners integrate with SuperAPI. We've divided the documentation into sections, each of which are designed to help you understand how SuperAPI integrates with your software.
Getting started
- SuperAPI Overview: This is the best starting point for understanding how SuperAPI works.
- What SuperAPI modules are available?
Tutorials
- Ready to go? Follow the tutorial on how to integrate SuperAPI.
How-to guides
- How to request access to our partner dashboard
- How to implement our hosted MFA
API keys
- How do I rotate my API keys?
- How do I verify my product API key is working and view product settings?
Webhooks
- How do I ensure webhook security?
- How do I work with webhooks locally?
Creating entities
- How do I dynamically create products?
- How do I create an employer?
- How do I work with onboarding sessions?
- How do I update details on an employee (like superannuation)?
Theming
- How do I customise the look and feel of the embeds?
General
- How does an employer activate stapling in the access manager?
- How do I report a data breach to SuperAPI?
- How do I show fair work statements to employees?
Explanations
- Read a high-level overview of the steps required to integrate your software with SuperAPI.
- What is the difference between product keys and partner keys?
- What is the difference between partners, employers, employees, and onboarding sessions?
- Understand the employer status fields so that you can customise your UI to communicate the employer's onboarding setup.
- Understand the lifecycle of an onboarding session
- Learn about onboarding templates and how they can be used to customise the onboarding session.
- What is SuperAPI in a box?
References
- View our live swagger spec
- Download our Postman collection to easily explore the API.
- View the list of webhooks that you can expect to be emitted from SuperAPI, along with the payloads they will contain. (this is currently a work in progress)
- View the list of workflow slugs that are available to partners.
- View the authentication requirements required when embedding SuperAPI.
Getting help
Stuck with something and need help? Please contact us at [email protected] or by phone on 0405 472 748 (Sam).