Circle’s sandbox environment is a development tool that allows you to safely
test prototypes and integration without generating actual financial
transactions. Sandbox APIs match those in production, making it easy to move
into the production phase.
To ensure success, please note the following:
- Before running these tests, make sure that you have a
sandbox account and an API key.
Testing Raw Connectivity
To test raw connectivity, you can use the service health
ping API endpoint, as below.
curl -H 'Accept: application/json' \
-X GET --url https://api-sandbox.circle.com/ping
Successful ResponseIf you reached the API endpoint, you’ll see the response {“message” : “pong”}.
Testing Your API Key
Verify that your API key is set up correctly by using the
get configuration info
API endpoint, as below.
curl -H 'Accept: application/json' \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-X GET --url https://api-sandbox.circle.com/v1/configuration
Successful Response:
{ "data": { "payments": { "masterWalletId": "1234567890" } } }
Error Response:
{
"code": 401,
"message": "Malformed authorization. Are the credentials properly encoded?"
}