Skip to main content

Sandbox API

With our sandbox environment you will be able to test the main endpoints of the API, including the following actions:

  • Create a new User
  • Create a new Account
  • Retrieve information about Users and Accounts

Create Users and Accounts

The full documentation for this endpoint can be found here.

curl --location --request POST 'https://sandbox.palenca.com/v1/users' \
--header 'x-api-key: private_api_key' \
--header 'Content-Type: application/json'
--data-raw '{
"widget_id": "feecb679-a3cc-47ef-8fd4-600799f12a39"
}'

Returns a JSON structured like this:

{
"success": true,
"error": null,
"data": {
"user_id": "054d0a9d-38ec-40cb-a31c-09b483242e4a",
"external_id": "4a0e32bd-c3df-4172-a89d-f173d6816926",
"widget_id": "feecb679-a3cc-47ef-8fd4-600799f12a39"
}
}
Note

While using the sandbox, the users and accounts created will remain in memory for two hours in order to guarantee a good understanding of the relations between the entities.

If you want to get basic information about the Users and Accounts, you can use the following endpoints:

The full documentation for this endpoint can be found here.

curl --location --request GET 'https://sandbox.palenca.com/v1/users/:user_id' \
--header 'x-api-key: private_api_key' \
--header 'Content-Type: application/json'

Returns a JSON structured like this:

{
"success": true,
"error": null,
"data": {
"user_id": "9334389a-c93c-4183-9894-ea8eb72f82e8",
"external_id": "e69bdbc2-495c-4356-be5f-13c55644a80b",
"widget_id": "feecb679-a3cc-47ef-8fd4-600799f12a39"
}
}

Retrieve Account Information

Now that you have a User and an Account, with it's corresponding ids, you can use the following endpoints to retrieve information about them

The full documentation for this endpoint can be found here.

curl --location --request GET 'https://sandbox.palenca.com/v1/accounts/:account_id/profile' \
--header 'x-api-key: private_api_key' \
--header 'Content-Type: application/json'
Note

You may have noticed the API Host URL is pointing to https://sandbox.palenca.com/. It is very important to use it this way to ensure you are working in the sandbox environment.