API de SolarAnywhere

La API (interfaz de programación de aplicaciones) de SolarAnywhere® permite a los usuarios automatizar la recuperación de datos y simulaciones fotovoltaicas de SolarAnywhere. La API permite conectar los servicios de SolarAnywhere a las herramientas creadas por el cliente y a las aplicaciones de software de terceros. La API es beneficiosa para los clientes que deseen:

• Acceda a los servicios de modeladoenergético de SolarAnywhere
• Automatice la evaluación comparativa del rendimiento de la flota con datos en tiempo real y simulaciones energéticas
• Ingesta continua de las últimas previsiones solares de SolarAnywhere
• Agilizar el acceso a los datos de SolarAnywhere en herramientas de simulación fotovoltaica de terceros, como PlantPredict, pvDesign y PVsyst
• Recuperar los datos de SolarAnywhere de una gran zona o flota

El uso de la API de SolarAnywhere se incluye con la compra de cualquier licencia de sitios o con la compra de una licencia típica de año ilimitado. Además, la API es el principal medio de recuperación de datos para los clientes de SolarAnywhere SystemCheck y también puede utilizarse para acceder a los datos de SolarAnywhere Forecast.

Además, los sitios públicos, que incluyen datos históricos completos de series temporales en tiempo real, están disponibles para probar la API, sin necesidad de comprarla.

Documentación de la API de SolarAnywhere

Accede a la documentación de la API de SolarAnywhere haciendo clic en el botón de abajo.

Documentación de la API
* Para acceder al sitio original de documentación de la API, haga clic aquí.

La documentación de la API de SolarAnywhere ahora está disponible a través de Postman. Vea el siguiente vídeo para obtener más información.

La siguiente información explica cómo empezar a utilizar la API de SolarAnywhere.

Crear y gestionar clientes de la API

Ten en cuenta que necesitarás ser un administrador de licencias designado en una cuenta de SolarAnywhere para poder crear y administrar clientes API. Aprende más sobre los roles de usuario de SolarAnywhere aquí.

Los clientes API son entidades en tu cuenta de SolarAnywhere que pueden usarse para acceder a tus datos con licencia a través de la API. No están ligados a usuarios específicos en tu cuenta, lo que ayuda a prevenir interrupciones en las automatizaciones debido a cambios de personal. Cada cliente API consiste en un nombre de cliente designado por el usuario y una clave API generada por SolarAnywhere. La clave API es una cadena única de 64 caracteres que debe ser tratada como una contraseña.

Si eres un administrador de licencias en tu cuenta de SolarAnywhere, puedes crear un cliente API navegando a la página de Licencias después de iniciar sesión y siguiendo estos pasos:

1. Desplácese hasta la sección "Gestión de clientes de la API".
2. Escriba un nombre en el cuadro de texto (el nombre no hace nada; es sólo un identificador útil)
3. Haga clic en el botón "Nuevo cliente API" y espere a que aparezca la ventana emergente
4. Almacenar de forma segura la ApiKey que se le da en la ventana emergente

Para mantener protegidas las claves API de los clientes, no las almacenamos. Esto significa que no podemos recuperar una clave una vez que se cierra la ventana emergente. Sin embargo, las claves se pueden volver a generar fácilmente utilizando el método que se explica en las instrucciones y el vídeo que aparecen a continuación.

Instrucciones

La sección "Administración de clientes de la API" de la página de Licencia en tu cuenta de SolarAnywhere contiene una tabla que muestra todos los clientes de la API en tu licencia de SolarAnywhere. Muestra los nombres, los prefijos de las claves, los estados (activo/desactivado) y la información de uso, como la hora de creación, la última hora de uso y varias categorías de estadísticas de uso agregadas para cada cliente. Los gestores de licencias pueden cambiar el nombre de los clientes, restablecer las claves de los clientes y suspender o eliminar clientes mediante el menú que aparece al seleccionar los tres puntos del extremo derecho de la tabla. El restablecimiento de una clave de cliente sustituirá la clave existente por una nueva generada.

Deberás enviar una clave de API válida de SolarAnywhere con cada solicitud de API de SolarAnywhere.¹ La clave debe incluirse como un encabezado de solicitud con el siguiente formato:

"X-Api-Key": "[Clave API de 64 caracteres]"

Límites de estrangulamiento de la clave API de SolarAnywhere

Cada clave API de SolarAnywhere tiene un límite de ráfaga predeterminado de 2.000 solicitudes con una tasa de recarga de 0,4 solicitudes por segundo. Mantener una cadencia de una solicitud API (POST o GET) por segundo mantendrá sus solicitudes dentro del límite. No obstante, póngase en contacto con support@solaranywhere.com para estudiar opciones de límite de velocidad más elevadas si fuera necesario.

Para utilizar la API de SolarAnywhere de la manera más eficiente, recomendamos agrupar varias ubicaciones en una sola solicitud POST. Las ubicaciones deben agruparse en función de la duración del período de datos que se solicita, con menos sitios incluidos para períodos de datos más largos. Consulte la siguiente tabla para obtener orientación sobre la agrupación de ubicaciones.

Estas directrices se aplican a los clientes que solicitan datos históricos, en tiempo real o de previsión con una resolución espacial de 1 km o 10 km y una resolución temporal de 15, 30 o 60 minutos. La solicitud de datos de alta resolución (5 minutos, 500 m), datos hindcast o resultados modelizados puede conllevar un aumento del tiempo de procesamiento.

Si está interesado en recibir orientación personalizada sobre la programación de llamadas a la API para su caso de uso, póngase en contacto con support@solaranywhere.com.

¹ Las solicitudes de la API realizadas con credenciales de autenticación básica (nombre de usuario y contraseña) asignadas previamente a su empresa por el equipo de SolarAnywhere siguen siendo válidas.