Environments¶
For end users, there are a suite of environments of the CIP-API that are available.
To request access to a specific environment, please contact Genomics England Service desk at ge-servicedesk@genomicsengland.co.uk
| Name | Host | Network Access | Purpose | Test Data | 100K Data | NHS GMS Data | AD Tenent ID |
|---|---|---|---|---|---|---|---|
| SIT | https://cipapi-beta.genomicsengland.co.uk | Internet | System Integration Testing | Yes | No | No | 99515578-fda0-444c-8f5a-2005038880f2 |
| UAT | https://cipapi-gms-beta.genomicsengland.nhs.uk | HSCN | Witness testing TPIs and UAT Testing | Yes | Yes | No | afee026d-8f37-400e-8869-72d9124873e4 |
| PROD | https://cipapi.genomicsengland.nhs.uk | HSCN | Production Instance | No | Yes | Yes | Issued upon request |
System Integration Test Environment¶
CIP-API SIT is a standalone CIP-API / Interpretation Portal environment containing mocked data that TPIs can use to test their integrations with CIP-API.
It is available on the public internet at: https://cipapi-beta.genomicsengland.co.uk/api/2/docs/
It will contain a copy of all the data from the Genomics England end-to-end test (e2e) environment.
Third Party Integrators (TPIs) will be able to use this environment during the development stages before they have been through the CIP-API assurance process.
This environment should be used to test new features "safely" before testing in UAT environment. Genomics England will release to SIT at the same time as releasing to e2e to give TPIs early access to changes.
Limitations of SIT environment¶
- The instance is standalone; it is not connected to the wider NGIS environment (e.g. re-identification service)
- The data is mocked and cannot be considered representative of "real" clinical cases. (However the data will conform to the same data models as real cases)
- The data should not be considered stable, and it is liable to change at any time.
- We will release CIP-API updates to SIT environment before they have been through the full e2e testing process. Therefore it should not be considered stable or bug-free.
- SIT uses the development AD tenant, so users will need different client credentials to UAT environment. If you require these credentials please contact service desk
Example Uses of SIT environment:¶
- Can my application authenticate?
- Can my application get a list of referrals, can it get a single referral?
- Can I test a new feature in my application?
- Can I test a new feature of the CIP-API?
- Can I test how this parameter works with my application?
- What HTTP response codes do I get?
UAT Environment¶
The User Acceptance Testing (UAT) environment is used for official GLH user testing of NGIS releases before they are released to production. The environment is under full change control and release management to mimic live service.
The environment has a complete set of "test cases" covering both "normal" and "edge" case scenarios
Limitations of UAT environment¶
- Code releases to the UAT environment are restricted to NGIS releases
- TPI testing in the UAT environment can adversely impact other ongoing UAT therefore should only be performed during official NGIS TPI Onboarding
Example Uses of UAT environment¶
- Witness testing TPIs
- Testing TPIs with the re-identification service