API de SolarAnywhere

L'API (interface de programmation d'applications) de SolarAnywhere® permet aux utilisateurs d'automatiser la récupération des données et des simulations photovoltaïques de SolarAnywhere. L'API permet de connecter les services SolarAnywhere à des outils développés par le client et à des applications logicielles tierces. L'API est avantageuse pour les clients qui souhaitent :

• Accéder aux services de modélisation énergétique deSolarAnywhere
• Automatiser l'évaluation comparative des performances de la flotte grâce à des données en temps réel et à des simulations énergétiques.
• Intégrez en permanence les dernières prévisions solaires de SolarAnywhere.
• Rationaliser l'accès aux données SolarAnywhere dans les outils de simulation PV tiers tels que PlantPredict, pvDesign et PVsyst.
• Récupérer les données SolarAnywhere d'une grande zone ou d'une flotte.

L'utilisation de l'API de SolarAnywhere est incluse dans l'achat de toute licence de site ou dans l'achat d'une licence illimitée pour une année type. En outre, l'API est le principal moyen d'extraction de données pour les clients de SolarAnywhere SystemCheck et peut également être utilisée pour accéder aux données de SolarAnywhere Forecast.

En outre, les sites publics, qui comprennent des séries de données historiques complètes en temps réel, sont disponibles pour tester l'API - aucun achat requis !

Documentation de l'API SolarAnywhere

Accédez à la documentation API de SolarAnywhere en cliquant sur le bouton ci-dessous.

Documentation de l'API*
* Pour accéder à la documentation originale de l'API, cliquez ici.

La documentation de l'API SolarAnywhere est maintenant disponible via Postman. Regardez la vidéo suivante pour en savoir plus.

Les informations ci-dessous expliquent comment démarrer avec l'API SolarAnywhere.

Créer et gérer les clients API

Veuillez noter que vous devez être un gestionnaire de licence désigné sur un compte SolarAnywhere pour pouvoir créer et gérer des clients API. Pour en savoir plus sur les rôles des utilisateurs de SolarAnywhere , cliquez ici.

Les clients API sont des entités de votre compte SolarAnywhere qui peuvent être utilisées pour accéder à vos données sous licence via l'API. Ils ne sont pas liés à des utilisateurs spécifiques de votre compte, ce qui permet d'éviter les interruptions des automatisations dues à des changements de personnel. Chaque client API se compose d'un nom de client désigné par l'utilisateur et d'une clé API générée par SolarAnywhere. La clé API est une chaîne unique de 64 caractères qui doit être traitée comme un mot de passe.

Si vous êtes un gestionnaire de licence sur votre compte SolarAnywhere, vous pouvez créer un client API en naviguant vers la page Licence après vous être connecté et en suivant ces étapes :

1. Faites défiler vers le bas jusqu'à la section intitulée "Gestion du client API".
2. Tapez un nom dans la zone de texte (le nom ne sert à rien, c'est juste un identifiant utile).
3. Cliquez sur le bouton "Nouveau client API" et attendez la fenêtre contextuelle.
4. Stockez en toute sécurité la clé ApiKey qui vous a été donnée dans la fenêtre pop-up.

Pour protéger les clés API des clients, nous ne les stockons pas. Cela signifie que nous ne pouvons pas récupérer une clé une fois que le popup est fermé. Cependant, les clés peuvent être facilement générées à nouveau en utilisant la méthode décrite dans les instructions et la vidéo ci-dessous.

Instructions

La section "Gestion des clients API" de la page Licence de votre compte SolarAnywhere contient un tableau affichant tous les clients API de votre licence SolarAnywhere. Il affiche les noms, les préfixes des clés, les statuts (actif/désactivé) et les informations d'utilisation telles que l'heure de création, la dernière heure d'utilisation et plusieurs catégories de statistiques d'utilisation agrégées pour chaque client. Les gestionnaires de licences peuvent renommer les clients, réinitialiser les clés client, et suspendre ou supprimer les clients en utilisant le menu qui apparaît en sélectionnant les trois points à l'extrême droite du tableau. La réinitialisation d'une clé client remplace la clé existante par une clé nouvellement générée.

Vous devez soumettre une clé API SolarAnywhere valide avec chaque demande API SolarAnywhere.¹ La clé doit être incluse dans un en-tête de requête au format suivant :

X-Api-Key' : "[Clé d'API de 64 caractères]"

Limites d'étranglement des clés API de SolarAnywhere

Chaque clé API de SolarAnywhere se voit attribuer une limite par défaut de 2 000 requêtes avec un taux de remplissage de 0,4 requête par seconde. En maintenant une cadence d'une requête API (POST ou GET) par seconde, vos requêtes resteront bien en deçà de la limite. Cependant, veuillez contacter support@solaranywhere.com pour discuter d'options de limites de taux plus élevées si nécessaire.

Pour utiliser l'API SolarAnywhere le plus efficacement possible, nous recommandons de regrouper plusieurs sites en une seule requête POST. Les sites doivent être regroupés en fonction de la durée de la période de données demandée, moins de sites étant inclus pour les périodes de données plus longues. Reportez-vous au tableau suivant pour obtenir des conseils sur le regroupement des sites.

Ces lignes directrices s'appliquent aux clients qui demandent des données historiques, en temps réel ou des prévisions à une résolution spatiale de 1 km ou 10 km et à une résolution temporelle de 15, 30 ou 60 minutes. La demande de données à haute résolution (5 minutes, 500 m), de données rétrospectives ou de résultats modélisés peut entraîner une augmentation du temps de traitement.

Si vous souhaitez recevoir des conseils personnalisés sur la programmation des appels API pour votre cas d'utilisation, veuillez contacter support@solaranywhere.com.

¹ Les demandes d'API effectuées à l'aide des informations d'authentification de base (nom d'utilisateur et mot de passe) précédemment attribuées à votre entreprise par l'équipe SolarAnywhere sont toujours valables.