Guides

Using the API Explorer

Suggest Edits

The Dexatel API Explorer is an interactive tool designed to help you familiarize yourself with our API's functionalities in a live environment. Without writing a single line of code, you can make API requests, explore different endpoints, and view responses directly from your web browser. This powerful tool simplifies the learning curve and accelerates your development process by allowing you to experiment with our API in real time.

Accessing the API Explorer

🚧

Important Note on Account Charges

When using the Dexatel API Explorer with your account credentials to make requests, please be aware that your account will be charged for the transactions you perform.

The Dexatel API Explorer is accessible without needing to log in, making it easier to start experimenting immediately. However, to use the API Explorer, you will need an API key, which is used to authenticate your requests.

To generate an API key:

  1. Navigate to your Dexatel account dashboard. If you don't have an account yet, you can create one for free by clicking the "Start for free" button on our website.
  2. Once logged in, locate the APIs section on the left-hand side menu where you can generate and manage your API keys.
  3. Click the "Create a Key" button and follow the instructions to create your API key.

With your API key in hand, you're ready to explore the capabilities of the Dexatel API through the API Explorer.

How to Use the API Explorer

Step 1: Choose an Endpoint

Start by selecting the API endpoint you want to explore. The API Explorer categorizes endpoints by functionality, such as SMS, Contacts, Reports, and Account Management. Click on an endpoint to begin crafting your request.

Step 2: Configure Your Request

After selecting an endpoint, you'll see a form where you can input the parameters required for your request. Fill in the necessary fields based on the action you want to test. For example, when using the SMS API to send a message, enter the recipient's number, your registered number, and the message content.

Step 3: Send the Request

Once you've configured your request, click the "Send Request" button. The API Explorer will immediately process your request and display the response in real-time. You'll see the complete response from the API, including any data returned and relevant HTTP status codes.

Step 4: Review the Response

Analyze the response data and status to understand how the API behaves for your request. Use this feedback to adjust your parameters and test different scenarios. This step is crucial for integrating the API into your application correctly.

Best Practices

  • Experiment with Different Endpoints: Use the API Explorer to familiarize yourself with all the available functionalities.
  • Test Edge Cases: Use the tool to test how the API handles various edge cases and error conditions.
  • Review Documentation: For each endpoint you explore, review the corresponding documentation section to understand the parameters, possible responses, and usage limits.

The Dexatel API Explorer is a valuable tool for developers looking to integrate Dexatel's communication solutions into their applications. By providing a hands-on, interactive way to learn about and test our API, we aim to streamline your development process and enhance your application's communication capabilities. Happy exploring!

Updated 8 months ago