Una API REST (Representational State Transfer) es un conjunto de funciones que permite la comunicación y el intercambio de datos entre diferentes sistemas a través de la web. Utiliza métodos HTTP estándar como GET, POST, PUT, DELETE para realizar operaciones sobre recursos, representados en formato JSON. Las API REST son ampliamente utilizadas por su simplicidad, flexibilidad y escalabilidad.

La API REST de Plaspy proporciona una manera robusta y segura de integrar las funcionalidades de Plaspy en tus propias aplicaciones. Siguiendo las directrices anteriores, podrás realizar solicitudes eficientes y gestionar correctamente los errores y los límites de la API. Para más detalles, consulta la documentación completa de la API REST de Plaspy .

Usos de una API REST

• Integración de Sistemas: Permite que diferentes sistemas y aplicaciones se comuniquen y compartan datos de manera eficiente.
• Automatización de Procesos: Facilita la automatización de tareas y flujos de trabajo.
• Extensión de Funcionalidades: Permite a los desarrolladores agregar nuevas funcionalidades a las aplicaciones existentes sin necesidad de modificar el código base.
• Desarrollo de Aplicaciones Móviles: Provee una manera fácil de conectar aplicaciones móviles a servicios backend.
• Acceso Remoto a Servicios: Permite el acceso a servicios y datos desde cualquier lugar con conexión a internet.

Base URL de Peticiones

La base URL para todas las peticiones a la API REST de Plaspy es:

Método de Autenticación

Para comunicarte con el servicio de Plaspy, debes autenticarte utilizando un esquema OAuth. El primer paso es generar un Token de acceso tipo JWT (JSON Web Token). Este token se obtiene a través de la siguiente operación:

• Endpoint: /api/Auth/Token
• Método: POST
• Descripción: Obtener el Auth token necesario para realizar peticiones a otros endpoints de la API.

Cómo usar OAuth en Plaspy

1. Generar un Token de Autenticación:

   • Endpoint: /api/Auth/Token
   • Método: POST
   • Descripción: Obtener el Auth token necesario para realizar peticiones a otros endpoints de la API.
   • Ejemplo de solicitud:
     { "userName": "tu_nombre_de_usuario", "apiKey": "tu_api_key" }

2. Incluir el Token en las Peticiones:

   • Una vez obtenido el token, debes incluirlo en el encabezado de cada solicitud a la API.
   • Encabezado: Authorization: Bearer tu_token
   • Ejemplo de uso en una petición GET:
     GET /api/devices HTTP/1.1
     Host: api.plaspy.com
     Authorization: Bearer tu_token

Operaciones

A continuación, se presenta una tabla con las operaciones disponibles en la API REST de Plaspy:

Códigos de Estado HTTP

Manejo de Errores

Los errores en la API REST de Plaspy tienen la siguiente estructura JSON:

• success: false cuando se produce un error en la petición.
• error: Mensaje que explica la causa del error.

Límite de Solicitudes

Es importante tener en cuenta los siguientes límites al integrar la API de Plaspy:

• Solicitudes por minuto: Máximo de 60 peticiones.
• Resultados por dispositivo diario: Límite de 25,000 resultados.

Estos límites están diseñados para asegurar el rendimiento y la estabilidad del sistema.