Verify my product API key and view product settings

It's likely that if you're reading this guide, you've already been issued an API key and want to perform a basic check to make sure that you can successfully access SuperAPI. This guide has been written with the tool curl in mind but should also work equally well with tools like Postman and others.

You can also use this endpoint to view the settings stored against the product, such as webhook_url, target_origin and webhook_signing_token.

INFO

If you haven't been issued an API key, request one from: support@superapi.com.au

Step 1

The first step is to issue a request to a special endpoint we have that will return details about the product that the key is associated with. To do so:

curl -X GET https://api.superapi.com.au/api/v1/product \
  -H "Content-Type: application/json" \
  -H "x-api-key: superapiproduct_yourkeyQvyaXOF"

TIP

Remember to replace the x-api-key header with the API key that has been provisioned for you.

Step 2

After issuing the curl request above, you will receive a payload similar to the following. This payload contains the details about the product you are currently authenticated as. It will be similar to:

{
  "data": {
    "id": "bffc9067-28ee-4381-a0f2-92fae25d9f83",
    "name": "Your Product Name",
    "slug": "your-product-name",
    "target_origin": "https://example.com",
    "webhook_url": "https://example.com/webhook",
    "webhook_signing_token": "REDACTED",
    "bank_details_configuration": {
      "id": "80b81e0e-f142-43b3-9115-70674f0ff9c8",
      "max_percentage_accounts": null,
      "max_fixed_accounts": null,
      "max_bank_accounts": 3
    },
    "tfn_declarations_configuration": {
      "id": "bef7203c-baea-4ae6-b2a4-2a100e836582",
      "allow_user_edits": true
    }
  },
  "version": "v1"
}

After you've got your product key working, check out how to create an employer.