A REST API (Representational State Transfer) is a set of functions that allows communication and data exchange between different systems over the web. It uses standard HTTP methods such as GET, POST, PUT, DELETE to perform operations on resources, represented in JSON format. REST APIs are widely used for their simplicity, flexibility, and scalability.

The Plaspy REST API provides a robust and secure way to integrate Plaspy's functionalities into your own applications. By following the guidelines above, you can make efficient requests and correctly manage errors and API limits. For more details, refer to the full Plaspy REST API documentation .

Uses of a REST API

• System Integration: Allows different systems and applications to communicate and share data efficiently.
• Process Automation: Facilitates the automation of tasks and workflows.
• Functionality Extension: Enables developers to add new functionalities to existing applications without modifying the base code.
• Mobile Application Development: Provides an easy way to connect mobile applications to backend services.
• Remote Access to Services: Allows access to services and data from anywhere with an internet connection.

Base URL for Requests

The base URL for all requests to the Plaspy REST API is:

Authentication Method

To communicate with the Plaspy service, you must authenticate using an OAuth scheme. The first step is to generate a JWT (JSON Web Token) access token. This token is obtained through the following operation:

• Endpoint: /api/Auth/Token
• Method: POST
• Description: Obtain the Auth token required to make requests to other API endpoints.

How to Use OAuth in Plaspy

1. Generate an Authentication Token:

   • Endpoint: /api/Auth/Token
   • Method: POST
   • Description: Obtain the Auth token required to make requests to other API endpoints.
   • Request Example:
     { "userName": "your_username", "apiKey": "your_api_key" }

2. Include the Token in Requests:

   • Once the token is obtained, you must include it in the header of each API request.
   • Header: Authorization: Bearer your_token
   • Example of a GET request:
     GET /api/devices
     HTTP/1.1 Host: api.plaspy.com
     Authorization: Bearer your_token

Operations

Below is a table of available operations in the Plaspy REST API:

HTTP Status Codes

Error Handling

Errors in the Plaspy REST API have the following JSON structure:

• success: false when an error occurs in the request.
• error: Message explaining the cause of the error.

Request Limits

It is important to consider the following limits when integrating the Plaspy API:

• Requests per minute: Maximum of 60 requests.
• Daily results per device: Limit of 25,000 results.

These limits are designed to ensure the performance and stability of the system.