Go live
From sandbox to production.
5 steps stand between your sandbox keys and your production keys. The portal checks some of them by itself, an operator reviews others, and the rest you accept online. You can see where your app stands at any time in Console.
01Before you start
Have these ready
None of this is needed to use the sandbox. Collect it when you are close to launch, so that no step waits on you.
An app with its groups
An app in Console, subscribed to every API group you will use in production. Go-live is per app, and it looks at the groups on that app.
Test calls in the log
For each of those groups, one successful sandbox call and one failure scenario. Calls you made earlier still count.
Company details
Your company's registered name, its registration number and a person we can contact about the integration.
Someone who can accept
A person with the authority to accept an agreement for your organization. They need an account in your team.
02The route
5 steps, taken in order.
A step opens when the one before it is done. Until then it is locked. Each app has its own route, so you can take one app live while another stays in the sandbox.
- 01
Checked by the portal
Pass the sandbox test cases
The portal reads your app's request log. There is nothing to upload. For every API group the app is subscribed to, the log must hold one call that succeeded and one call that ran a failure scenario.
A scenario counts as a failure when it is not the operation's default, or when it answers 400 or above. Errors from the gateway itself, such as
RATE_LIMITED, do not count, because no scenario ran. Find the values that trigger each failure. - 02
Reviewed by an operator
Verify your business
Have your company's registration details and the name of a contact person ready. You fill in a short form in Console and an operator checks it.
If something is missing, the step comes back to you with a note. Correct it and send it again.
The form asks for
- Registered company nameRequired
- Company registration numberRequired
- Country of registrationRequired
- Contact personRequired
- Contact phoneRequired
- 03
You accept online
Accept the production agreement
You accept the production agreement in Console by ticking one box. You accept it for your whole organization, so the person who does it needs the authority to.
The portal records who accepted and when.
- 04
Reviewed by an operator
Operator approval
An operator takes a last look at the app, the groups it uses and its sandbox traffic. There is nothing new to prepare.
If they need something changed, the step comes back to you with a note.
The form asks for
- Anything the reviewer should know?Optional
- 05
Checked by the portal
Production keys issued
When every earlier step is done, an Issue production keys button appears. The new key pair is listed on the app next to your sandbox keys. Copy the secret when it is shown. It is not stored and cannot be shown again.
Your sandbox keys keep working, so you can go on testing new scenarios after launch. Production calls go to
https://devportal.softwaregroup.com/api/live, with the same paths as the sandbox.
Pick an app and start the route.
Console shows each step, what is still missing and who has to act next.