Network APIs Playground
The Network APIs requires operators' approval. This process could take more or less time, but developers can only use the APIs once the first approvals arrive.
The Playground allows developers to start using the Network APIs while waiting for approval of their business profile by the operators.
Enable the Playground in your Application
To start using the Playground, 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.
- Finally, enable the Network APIs capability in your application and select the “Playground” access type.
Once the Playground is configured and the Network APIs capability is added to your application, you can begin testing Vonage Network APIs. The Playground can either use live data, where developers can configure up to 5 allowlisted phone numbers, or a Virtual Operator, which provides predefined and deterministic API responses using the parameters of the API request. You will find more information on both methods below.
Virtual Operator
The Playground requires at least one working phone number added to the allowlist from a supporting operator and, in the case of Number Verification, mobile data access to a supported operator. There may be scenarios where allowlisting a valid phone number is not possible, such as when testing the Network APIs in a country that is not yet supported.
To solve this situation, the Playground offers a Virtual Operator that provides predefined and deterministic API responses based on the parameters of the API request. See the Virtual Operator guide for more detailed information.
Allowlist Phone Numbers
To use live data with the Playground, open the Vonage Network APIs Playground in your dashboard and select the “Network APIs Playground” tab button. Then, click “View Available Operators” to uncollapse the list of available network partners that can be used in the Playground. You can add up to 5 numbers to be allowlisted from one or more available operators.
Click on the “Add numbers” button, and for each test phone number, do the following:
- Choose the country code from the available countries
- Input the phone number you'll use for testing
- Check the box to confirm the number will only be used for test purposes
Click "Verify" and the phone number will receive an authentication code via SMS. Enter the code provided to complete the number verification.
Once the verification code is added and verification is successful, the test number will be allowlisted successfully and you are ready to start testing the Network APIs.