Developer Sandbox
This guide will help you get started using Oyster's developer sandbox.
We offer developer sandboxes with some seed data to use for integration development. To request a developer sandbox, email [email protected] with your name, company name, and corporate email address. With that information, we will issue you a login where you can login at https://sandbox.oysterhr.com/users/sign_in.
Please note that it is not possible to add any additional users to your developer sandbox account. We will issue one login for the account that will need to be shared among your team. Developer sandboxes also do not send any emails.
To use the developer sandbox API, you will follow the same instructions in the guide to creating and authorizing a Developer Application (see here for the Partner guide and here for the Customer guide) but use the following sandbox URLs:
- For token generation - https://api-sandbox.oysterhr.com/oauth2/token
- For all other API calls - https://api-sandbox.oysterhr.com
Note: Once you are ready to use your integration, make sure to create a production developer application and generate production tokens in the production environment (see here for the Partner guide and here for the Customer guide). You will then need to change the paths for your requests in your integration from the sandbox environment to the production paths.
Updated 2 months ago