Aurora utilise les Portées d'accès pour définir comment les applications et services externes peuvent accéder aux données de votre locataire. Chaque portée d'accès définit la capacité de lire ou de modifier les données de votre locataire en fonction d'un ensemble de points de terminaison de l'API Aurora. Par exemple, la portée read_projects permet aux applications de récupérer des informations de base sur un projet, de voir les actifs d'un projet et de récupérer les informations AHJ pour un projet.
Pour connaître les données exactes exposées pour chaque portée d'accès, consultez la documentation de l'API pour les points de terminaison concernés sur docs.aurorasolar.com
Toutes les portées d'accès
Pour une liste de toutes les portées d'accès, et des points de terminaison associés à chaque portée, veuillez consulter ci-dessous :
| Portée | Points de terminaison API
|
|---|---|
| read_tenants | Récupérer le locataire |
| read_versions | Récupérer les versions |
| write_versions | Mettre à niveau la version, Revenir à la version précédente |
| read_users | Récupérer l'utilisateur, Lister les rôles |
| list_users | Lister les utilisateurs |
| write_users | Créer un utilisateur, Inviter un utilisateur, Mettre à jour un utilisateur, Activer un utilisateur, Désactiver un utilisateur |
| read_sso_providers | Récupérer le fournisseur SSO |
| write_sso_providers | Créer un fournisseur SSO, Mettre à jour un fournisseur SSO |
| read_teams | Lister les équipes |
| read_partners | Lister les partenaires, Récupérer le partenaire |
| write_partners | Créer un partenaire, Mettre à jour un partenaire, Ajouter des utilisateurs au partenaire, Mettre à jour les utilisateurs du partenaire, Télécharger le logo du partenaire |
| read_consumer_orders | Lister les commandes, Récupérer la commande |
| write_consumer_orders | Mettre à jour la commande, Refuser la commande, Marquer la commande comme vendue |
| read_projects | Récupérer le projet, Lister les actifs du projet, Récupérer l'AHJ, Récupérer le résumé de facturation du projet |
| list_projects | Lister les projets |
| write_projects | Créer un projet, Mettre à jour un projet, Supprimer un projet, Créer un actif de projet, Convertir une commande en projet, Récupérer le statut de conversion de commande en projet |
| read_consumption_profiles | Récupérer le profil de consommation, Lister les factures de services publics, Récupérer la facture de services publics |
| write_consumption_profiles | Mettre à jour le profil de consommation, Lancer le téléchargement de facture de services publics, Récupérer le statut du téléchargement de facture de services publics |
| read_design_requests | Lister les demandes de conception, Récupérer la demande de conception, Récupérer la demande de conception EagleView |
| write_design_requests | Créer une demande de conception, Accepter une demande de conception, Créer une demande de conception EagleView, Accepter une demande de conception EagleView |
| read_designs | Lister les conceptions, Récupérer la conception, Récupérer le résumé de conception, Récupérer le résumé du toit, Lister les réseaux de supports, Récupérer la proposition web, Récupérer la génération du PDF de proposition, Récupérer le statut AI Roof, Récupérer le résumé de facturation de la conception |
| write_designs | Créer une conception, Dupliquer une conception, Générer l'URL de la proposition web, Mettre à jour la nomenclature des supports, Mettre à jour la conception, Lancer la génération du PDF de proposition, Lancer AI Roof |
| read_design_assets | Lister les actifs de conception, Récupérer l'actif de conception |
| write_design_assets | Créer un actif de conception |
| read_components | Lister les modules, Récupérer le module, Lister les onduleurs, Récupérer l'onduleur, Lister les optimiseurs DC, Récupérer l'optimiseur DC |
| read_pricing | Récupérer les prix de conception |
| write_pricing | Mettre à jour les prix de conception, Créer un supplément, Supprimer un supplément |
| read_financing | Lister les financements, Récupérer le financement |
| write_financing | Envoyer le financement au financeur |
| read_proposals | Lister les modèles de proposition, Récupérer le modèle de proposition, Récupérer la proposition |
| write_proposals | Créer une proposition, Supprimer une proposition |
| read_agreements | Lister les accords, Récupérer l'accord, Récupérer le lien de l'accord, Lancer la génération de l'URL de téléchargement de l'accord, Récupérer l'URL de téléchargement de l'accord |
| read_site_surveys | Récupérer la demande d'enquête de site, Récupérer l'enquête de site, Lister les enquêtes de site |
| write_site_surveys | Créer une enquête de site, Mettre à jour l'aperçu de l'enquête de site, Mettre à jour les données électriques de l'enquête de site, Mettre à jour les sous-panneaux électriques de l'enquête de site, Mettre à jour les plans de montage de l'enquête de site, Mettre à jour le statut de l'enquête de site |
| read_plan_sets | Récupérer la demande de jeu de plans, Récupérer le jeu de plans |
| write_plan_sets | Créer une demande de jeu de plans |
| read_webhooks | Lister les webhooks, Récupérer le webhook |
| write_webhooks | Créer un webhook, Mettre à jour un webhook, Supprimer un webhook |
| read_shared_projects | Lister les projets partagés |
| write_project_records | Partager une étape clé |
| read_project_notes | Récupérer une note de projet, Récupérer les fichiers d'une note de projet |
| write_project_notes | Créer une note de projet, Mettre à jour une note de projet |
| run_design_automation | Lancer le placement du chemin d'incendie, Récupérer le statut du placement du chemin d'incendie, Lancer AutoDesigner, Récupérer le statut d'AutoDesigner, Lancer l'analyse d'irradiance, Récupérer le statut de l'analyse d'irradiance, Lancer la simulation de performance, Récupérer le statut de la simulation de performance |