Dynamically create products

In some situations you may want to create products in SuperAPI on the fly, for example one product per customer instance or per vanity subdomain. Products are created with your partner API key.

The requests are the same three you make when first setting up, so rather than repeat them here, follow these steps from the Getting Started guide:

1. Verify your partner key
2. Create a product with the name, target_origin and webhook_url for the new instance
3. Create a product API key for it

Store the returned api_key against the instance it belongs to. All subsequent requests for that instance use this key.

WARNING

Ensure you protect the product API key. Do not check it into your source code control.

Sandbox

Sandbox is a property of your partner, not of individual products. Every product you create under a sandboxed partner is sandboxed, and requests to the ATO and super fund APIs are simulated. When you are ready to go live, get in touch with us and we will take your partner out of the sandbox.

Updating a product

Product settings such as webhook_url, target_origin and the bank details configuration can be changed later with PUT /api/v1/partner/product/:id using the partner key. See the API reference for the full request body.