How to use our SandBox API

User Journey Documentation for Seen Tarbi Sandbox on Seen Tarbi DevPortal

Step 1: Go to Seen Tarbi Sandbox DevPortal

Navigate to the Seen Tarbi Sandbox DevPortal by visiting the following URL: https://devportal.xsquare.sa/.

Step 2: Click on Sign Up

Locate the "Sign Up" button on the DevPortal's homepage and click on it to begin the registration process.

Step 3: Create an Account on Seen Tarbi DevPortal

Fill in the required information to create your account on the Seen Tarbi DevPortal. This will include providing your email address, creating a secure password, and any other necessary details.

Step 4: Access the 'My Apps' Tab and Create a New Application

Once your account is successfully created, go to the 'My Apps' section. Here, create a new application by providing relevant details about your project.

Step 5: Copy the Client ID

After creating the application, click on 'View' to access the application details. Here, you will find the Client ID. Copy this unique identifier as it will be needed for authorization.

alt text

Step 6: Activate the Sandbox-API and Await Approval

In the 'Services' section of your application, locate the 'SandBox-API' option. Activate it and wait for your application to be approved to access the service. Approval might take some time and involves a review process.

Step 7: Access the Catalog and Select 'SandBox API'

Once your application is approved, navigate to the 'Catalog' tab. Find and click on 'SandBox API' to explore the available endpoints and functionalities.

Step 8: Authorize Your Application

Within the 'SandBox API' section, click on the 'Authorize' button. Paste the previously copied Client ID into the designated field. This step ensures your application is granted access to the Sandbox API.

Step 9: Execute Endpoints

With authorization granted, you can now execute any endpoint available in the SandBox API. To do this, click the arrow beside the desired endpoint to expand its details. Then, click on the 'Execute' button to test the endpoint.


What’s Next

Congratulations! You have successfully navigated the Seen Tarbi Sandbox on the Seen Tarbi DevPortal, created an application, received approval, and executed API endpoints for testing and development purposes. If you encounter any issues or have further questions, refer to the DevPortal's support resources or contact their support team for assistance.