What is the ROOK portal?
The ROOK portal is the platform for our clients where they can take their first steps towards integrating with ROOK. Here, they can configure their account, integration parameters, and monitor its functionality. This is our first release on the path to an automated platform for greater client autonomy.
image 1
What are the functionalities of the portal?
The portal offers various functionalities to help you get started with your integration with ROOK. Here are the following functionalities:
Connection status:
The Status Page allows you to view the overall functionality of the servers, providing insight into the stability of the integrations.
image 2
Settings:
  • Tokens:
    In this configuration, you can generate your Client_UIID, which serves as your identification within ROOK, and the Secret Key. Remember that you can only view the Secret Key once, as it is used to authorize all queries to our servers.
  • Connection Page:
    Here, you can configure the connection page, enabling you to choose the API or SDK you want to work with in your project. You can also customize the theme and URL where it will be displayed.
  • Notifications of Events:
    Notifications alert you to new events related to your users, allowing you to update information quickly and automatically.
Documentation:
Within the portal, you'll find a direct link to our technical documentation, providing you with easy access to information.
image 3
Getting Started:
We have prepared a 3-step onboarding process to help you configure your integration easily.
  • Step 1:
    Generate your tokens. Remember to save your Secret Key.
  • Step 2:
    Configure your connection page, specifying the URL, style, and APIs/SDKs you want to work with.
  • Step 3:
    Set up notifications for events and user summaries. You'll need to register a URL to receive automatic alerts.
image 4
Can I conduct tests?
Yes, we offer two working environments: Sandbox and Production.
  • Sandbox Environment:
    This environment is for integration testing. It has a limited number of users, and any changes made here won't affect the production environment.
  • Production Environment:
    This environment is for the live release of your integration to your clients. It automates processes and streamlines permissions. It becomes available when you contract ROOK's services. Remember that any changes you make here will be public.
Questions and Answers:
Can anyone create an account?
In this initial phase, users are authorized by ROOK. To integrate with ROOK, you can request a trial, and you'll be provided with access to the portal. If you want to contact us, click here.
Are the Sandbox and Production credentials the same?
No, you must generate separate credentials for each environment. Remember that you can only view the Secret Key once when generated. Make sure to store it securely for future use.
What if I lose my Secret Key? Can I generate a new one?
Yes, if you lose, forget, or wish to change your Secret Key, you can generate new credentials. However, we don't recommend doing this frequently.
Can I edit any configuration fields?
Yes, you can edit the configuration fields and your profile in both the sandbox and production environments.
Can I return to the sandbox environment after being in the production environment?
Yes, you can navigate between environments without issues. However, be careful with the changes made in each environment.
What if I forget my password?
You can easily recover your password through the portal login. Just ensure that you have access to your email.
Can I have additional roles or accounts for my collaborators?
Currently, we do not offer that functionality.
If you have any other questions or doubts, don't hesitate to contact us at