Announcing the New Network APIs Sandbox
Published on July 23, 2024

As the Introduction to the Network Registry blog post covered, accessing the Network APIs requires CSP (Communication Service Providers) approval. This process could take more or less time, but developers can only use the APIs once the first approvals arrive.

Today, we present the new Network Registry Sandbox, a secure environment that allows developers to explore the Network APIs from the beginning, ensuring the safety of users and CSPs.

The Sandbox uses live data and allows developers to configure up to 5 test numbers, ensuring that tests can only be performed with or from allowlisted numbers.

There are two main steps to use the Sandbox:

  1. Allowlist phone numbers

  2. Create a new application linked with the Sandbox

Allowlist Phone Numbers

Open the Vonage Network Registry Sandbox in your dashboard and select the “Network API Sandbox” tab button. Then, click “View Available CSPs” to uncollapse the list of available network partners that can be used in the Sandbox. Remember, you can add up to 5 numbers to be allowlisted from one or more available CSPs.

Screenshot of a 'Network Registry' page, specifically the 'Network API Sandbox' tab. The page welcomes users to the Network API Sandbox and allows them to configure up to 5 test numbers for exploring Network APIs. The available APIs include 'SIM Swap' and 'Number Verification' for fraud prevention and detection. Users can allowlist phone numbers by clicking 'Add numbers' and create an application for testing by clicking 'Create Application'. There's also an option to view available CSPs. A button to 'Add business profile' is located at the top right corner.Sandbox tab overview

Click on the “Add numbers” button, and for each test phone number, do the following:

  • Choose the country code from the available countries

  • Input your test number

  • Check the box to confirm the number will only be used for test purposes

The screenshot shows the dialog to add a new phone number to the Sandbox. The phone number field text include a selection box for the international code.Dialog to add a new phone number to the Sandbox

Our Verify API will send the phone number an authentication code via SMS. Enter the code provided to complete the number verification.

The screenshot shows the dialog where users must enter the verification code when adding new phone numbersSandbox verification code when adding new phone numbers

Once the verification code is added and verification is successful, the test number will be allowlisted successfully.

The screenshot shows the confirmation dialog after adding a new phone to the SandboxConfirmation dialog when adding phone to the Sandbox

Use the Sandbox in your Application

Once you have allowlisted the phone numbers you want to test, you will need to create an application. 

Click the “Create Application" button or navigate to the Applications section of your dashboard and "Create a new application".

Generate a public and private key pair for JWT creation during authentication. You'll need this JWT token to generate access tokens. Additional details about Network APIs authentication are available.

Finally, enable the Network APIs capability in your application and select the “Sandbox” access type.

The screenshot shows the dialog box within the Network APIs capability menu to choose Sandbox or Production access to the APIs.Sandbox selecting in Application

Once the Sandbox is configured and the Network APIs capability is added to your application, you can begin testing Vonage Network APIs.

Get in Touch

Have you used the Sandbox already? We’d love to hear your feedback! Join us on the Vonage Community Slack or message us on X, and we will get back to you. 

Thanks for reading!

Alvaro NavarroSenior Developer Advocate

Alvaro is a developer advocate at Vonage, focusing on Network APIs. Passionate about Developer Experience, APIs, and Open Source. Outside work, you can often find him exploring comic shops, attending sci-fi and horror festivals or crafting stuff with those renowned tiny plastic building blocks.

Ready to start building?

Experience seamless connectivity, real-time messaging, and crystal-clear voice and video calls-all at your fingertips.