Developer Resources
Build innovative healthcare recruitment solutions with NHSJob's developer tools and APIs.
Developer Resources
Sandbox Environment
The NHSJob Sandbox Environment allows you to test your integration with our API in a safe, isolated environment before deploying to production.
Getting Started
To use the sandbox environment, you'll need separate API credentials for testing. These credentials will only work with the sandbox endpoints.
Sandbox Base URL
https://sandbox-api.nhsjob.net/v1
Obtaining Sandbox Credentials
- Log in to the Developer Dashboard
- Navigate to the "Applications" section
- Select your application
- Click on the "Sandbox Keys" tab
- Generate your sandbox API key and OAuth credentials
Sandbox Features
Test Data
The sandbox environment includes pre-populated test data for jobs, candidates, employers, and applications.
Simulated Responses
Test various API responses, including error conditions, by using special test parameters.
Webhook Testing
Trigger webhook events manually to test your webhook handlers without waiting for actual events.
Rate Limit Simulation
Test how your application handles rate limiting with lower thresholds than production.
Test Accounts
The following test accounts are available for use in the sandbox environment:
Account Type | Password | Notes | |
---|---|---|---|
Candidate | test.candidate@example.com | sandbox-pass | Has complete profile with resume |
Employer | test.employer@example.com | sandbox-pass | Has active job listings |
Recruiter | test.recruiter@example.com | sandbox-pass | Agency with multiple job listings |
Admin | test.admin@example.com | sandbox-pass | Has admin privileges |
Testing Scenarios
Testing Payment Flows
The sandbox environment includes a test payment gateway that simulates payment processing without charging real money.
Test Credit Card Numbers:
4242 4242 4242 4242
- Successful payment4000 0000 0000 0002
- Declined payment4000 0000 0000 9995
- Insufficient funds
Use any future expiration date, any 3-digit CVC, and any postal code.
Testing Error Responses
Trigger specific error responses by using the following test values:
- Use job ID
error_not_found
to simulate a 404 Not Found response - Use candidate ID
error_unauthorized
to simulate a 401 Unauthorized response - Use
error_rate_limit
as a query parameter to simulate a 429 Rate Limit Exceeded response
Ready to Go Live?
Once you've thoroughly tested your integration in the sandbox environment, you're ready to switch to the production API.