Documentation forDameware Remote Everywhere

Using the REST API in DRE

The Dameware Remote Everywhere (DRE) REST API uses Swagger, an open-source framework that simplifies API development and documentation. It allows developers to design, build, document, and consume RESTful web services. In this guide, we'll walk through how to interact with a test API using Swagger, including fetching data programmatically using common programming languages.

Tools Required

  • HTTP client (like Postman or curl).
  • Programming languages (Python, JavaScript, PowerShell).

Avoid hardcoding API keys directly in your scripts for production applications. Instead, consider using environment variables or securely retrieving the keys from a server-side application.

Exploring the Swagger API

Step 1: Open Swagger UI

Step 2: Explore Endpoints

  • Use the interactive documentation to explore different endpoints.
  • Try out the endpoints directly in the browser to see the responses.

Handling API Responses

When making API requests, it's essential to handle responses correctly:

  • Check Status Codes — Ensure the request was successful by checking HTTP status codes (e.g., 200 for success).
  • Parse JSON — Most APIs return data in JSON format. Use appropriate methods to parse JSON data in your programming language.

Error Handling

  • Ensure your application can gracefully handle errors, such as network issues or invalid responses:
  • Retry Logic — Implement retry logic for transient errors.
  • Error Messages — Display user-friendly error messages.