Sandbox is our "try it out" environment where you register, create apps and try our APIs using pre-configured responses to understand what our REST APIs can do.
Once you have tried the APIs on our Sandbox, you can then progress to our Customer Verification Facility (CVF) to perform integration testing and once signed-off you can launch on to our Production environment (EMP)
| Step | Action | Notes |
|---|---|---|
| 1 | Register, activate and sign in |
When you register with your email and password, you will receive an email to activate your account.
When you click the activate link, you will be presented with a "change password" screen and once you have changed your password, you will be able to login |
| 2 | Explore the API Catalogue | Check out the available APIs |
| 3 | Read the documentation | Read the corresponding YAML, ICD and FCD specifications |
| 4 | Create an application | When you're ready to, then you can create an application which will provide you with the OAuth credentials |
| 5 | Allocate the APIs to your application | Now edit the application to add the APIs you are interested in |
| 6 | Try out the API | Use the OAuth credentials and try the APIs with our pre-configured (stubbed) responses |
The Openreach API Sandbox is one of the environments available to you. The other two, CVF and EMP are also available to use, but will require establishment and security processes to be completed before you can use them. You can learn more about this from our API portal page, which also covers what our API strategy is (You will need access to the Openreach CP portal to view this).
If you have any issues or questions, then reach out to on
