Skip to main content

ROOK Developer Portal FAQs: Sandbox, Production, API Credentials & Status

Answers about ROOK Sandbox and Production environments, client UUID, Secret Key, API authentication, environment switching, and service status.

Written by JP Gomez

Use this FAQ to understand ROOK Developer Portal environments, credentials, API authentication, and service status.

ROOK provides separate Sandbox and Production environments so you can safely build and validate your integration before connecting real end users. Each environment has its own credentials and configuration.

ROOK Sandbox and Production environments

  • What is the difference between ROOK Sandbox and Production?

    The ROOK Sandbox environment is designed for development, integration testing, and validation before going live. You can use Sandbox to test ROOK features, connect data sources, validate the flow between ROOK and your application, receive health data, and confirm that your integration behaves as expected.

    The ROOK Production environment is designed for live applications and real end users after your integration has been validated in Sandbox.

  • How do I enable the Production environment in ROOK?

    The ROOK Production environment is enabled after your contract has been signed and the first payment has been completed.

  • How do I switch between Sandbox and Production?

    You can switch between Sandbox and Production from the environment selector in the ROOK Portal.

    Open the environment selector in the upper-right area of the portal and select the environment you want to manage.

    When you change environments, the portal displays the credentials and configuration associated with the selected environment.

    Switching environments does not copy your Sandbox configuration into Production or vice versa.

  • Are ROOK Sandbox and Production credentials the same?

    No. ROOK Sandbox and Production use separate credentials.

    Each environment has its own client_uuid, Secret Key, and environment-specific configuration.

    When making API requests or configuring your integration, always verify that you are using credentials for the correct environment.

    Do not use Sandbox credentials for Production requests or Production credentials for Sandbox requests.

ROOK API credentials

  • What is a ROOK client UUID?

    A ROOK client_uuid is a unique UUID4 identifier assigned to your ROOK client within a specific environment.

    ROOK uses the client_uuid to identify which client and environment an API request belongs to and to associate users with the correct client configuration.

    Sandbox and Production have separate client_uuid values.

    You can find the client_uuid for the currently selected environment in the credentials area of the ROOK Portal.

    For additional details, read What is a ROOK client UUID?

  • What is the ROOK Secret Key?

    The ROOK Secret Key is a confidential credential used to securely authenticate requests to the ROOK API.

    The Secret Key is used together with your client_uuid for API authentication, including Basic Authentication on supported ROOK API endpoints.

    Each environment has its own credentials, so your Sandbox and Production Secret Keys are separate.

    Keep your Secret Key secure and do not share it publicly.

    When a Secret Key is generated, store it securely because it may only be displayed once.

    If you lose a Secret Key, generate a new one from the ROOK Portal and update the systems that use that credential.

    For additional details, read What is the ROOK Secret Key?

Monitoring and troubleshooting

  • Where can I check ROOK API and service status?

    You can check the current status of ROOK services on the official ROOK Status Page: https://rook.statuspage.io/

    The ROOK Status Page provides information about service availability, incidents, outages, and planned maintenance.

    If you are experiencing an integration issue, check the Status Page first to determine whether there is an active ROOK service incident.

Did this answer your question?