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.

Tutorials

• Ready to go? Follow the tutorial on how to integrate SuperAPI.

How to guides

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?

General

• How does an employer activate stapling in the access manager?

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
• Understand the life cycle of an onboarding session

References

• View our live swagger spec
• View the list of webhooks that you can expected to be emitted from SuperAPI, along with the payloads they will contain. (this is currently a work in progress)

Getting help

Stuck with something and need help? Please contact us at [email protected] or by phone at 0405 472 748 (Sam)