Legacy APIs in DRE
In addition to our REST API, we also offer our legacy API to create New Sessions, insert your own Landing Page, add a new Deferred Support Request and Validate requests from any software.
While we won’t be adding new features or functionality to our legacy APIs, we understand their importance in your current operations. Therefore, we are committed to maintaining their availability and providing ongoing support. This ensures that your operations relying on the legacy APIs continue to function without disruption. However, we recommend using our REST API for new calls and when updating existing legacy API calls.
Before using the APIs, the first step is to create the required API keys from Management > API Keys, as covered in Configure and manage your API Keys. The API keys listed in this section work with both the REST and legacy APIs.
For your API domain, got to Profile > APIs and review Your domain for APIs, replacing /rest with /integration/integration_api.php, /integration/tickets_api.php, or /integrations/get_history_api.php depending on your legacy API call.
Configure APIs
Use the API section of the Admin Area to create New Session, Landing Page, New Support Ticket and Validation APIs. Download the User Guide for each API to learn more.
To view information on the legacy APIs:
- Navigate to Profile > APIs.
-
Use the API Keys section to view the list of Endpoints and add the appropriate key in order to securely authenticate with your selected API.
- From the Start APIs tab, use The New Session API section to generate new sessions without using the console. For example, you can generate sessions from your company's website or CRM software. Click Help to access the New Session API documentation.
- Use the Landing Page API section to place an API on your own website. This gives your customers the ability to directly insert a PIN Code or Calling Card into your website.
- Select a Language and Code Type, and click Generate.
- Select Other APIs, and in the New Deferred Support Requests API section, click Help to view the documentation and learn how to create deferred support tickets directly from any application.
This API does not allow custom questions or attachments to be added to the ticket creation form. Files can be added at a later time by editing the ticket.
- Select Validation API, enter your API URL, and choose the default behavior if the validation call fails or times out. This API’s objective is to pre-process the customer’s data gathered by the Applet before the creation of a support request. Click Help to access the Validation API documentation.
- Enter the Test API information and click Test API to run a quick test.
- Save your API information to complete the set up process.
The parameters shown in this window are mandatory, and must be inserted exactly as presented in order to work correctly.