8000 Home · kdrag/prod-scwadd Wiki · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
林為義 (John Lin) edited this page Sep 25, 2022 · 7 revisions

ShareMyData Client Web Application Data Download (SCWADD)

Most up-to-date content is at here

This repository contains an implementation of a model NodeJS application that interacts with PG&E’s ShareMyData (SMD) platform, to facilitate download of a PG&E customer user energy data from the utility’s data access API service. The data access is done in the role of a third party data access client, and PG&E is acting as the data custodian for the customer, also referred to as the user.

For more on ShareMyData in general, please read Basics of ShareMyData first.

Basic Features of SCWADD

  • SCWADD leverages the “Click-Through” workflow of PG&E’s SMD platform, i.e. its OAuth2-based code grant flow for authorization of customer owned data access, with PG&E acting as the data custodian.

  • SCWADD leverages the “Click-Through” workflow of PG&E’s SMD platform, i.e. its OAuth2-based code grant flow for authorization of customer owned data access, with PG&E acting as the data custodian.

  • SCWADD first directs user to PG&E’s authentication page for SMD, at sharemydata.pge.com/myAuthorazation, so that a user may give data access permission (authorization) for a pre-configured and registered third-party (data access client registered at sharemydata.pge.com/#login).

  • Upon completion of data access authorization, i.e. user authorizes, and SCWADD completes the OAuth2 authorization code grant flow and acquires the bearer tokens, SCWADD commences electrical energy usage data pull for 12 months of data.

  • SCWADD then deletes the data access authorization by the user

  • In the end of the tranaction, SCWADD generates a CSV file for download directly from separately accessible directory

  • The user energy usage data is accessible by a username/password access to the {Configured SCWADD URL}/output directory

Articles

Quick Start

Introduction
* What is Green Button?
* What is PG&E’s ShareMyData?
* What is SCWADD – ShareMyData Client Web Application Data Download
* Why SCWADD

Interacting with SMD with SCWADD
* Basics of ShareMyData
* SCWADD and ShareMyData

Client Design in General
* Authentication
* Authorization
* Data Access

Client Application (SCWADD) Technology
* Execution Environment
* OAuth2 authorization and token management
* TLS1.2 Transport Layer Security for 
E571
Data Access
* SCWADD in Detail

Registering to use SMD API
Testing SCWADD Instance for PG&E Approval
* Performing the SMD Test
0