Tseem ceeb

Muab kuv cov ntaub ntawv rau peb ob tog

Pub peb tog mus saib tau koj cov ntaub ntawv zog siv cov ntaub ntawv

ícono de aviso importante Faj Seeb: Lub computer txhais lus no. Yog koj muaj lus nug, hu rau cov kev pab ntawm 1-877-660-6789.

Thib peb tog tuam txhab uas muag muaj tsom xam thiab cuab yeej pab koj txuag tau nyiaj.

Muab Kuv Cov Ntaub Ntawv Qhia Tawm Li Cas?

 

Muab kuv cov ntaub ntawv yog cov tiam tom ntej ntawm cov ntsuab Button Connect kuv cov ntaub ntawv® cuab yeej.

 

Twb sau npe ua ib qho kev pom zoo muab kuv cov ntaub ntawv Vendor?

Nkag mus rau hauv

 

Leej twg thiaj siv tau Kuv Cov Ntaub Ntawv?

 

  • Cov neeg muas zaub coj mus muag
  • Cov neeg siv hluav taws xob uas yog pej xeem
  • Tebchaws thiab soj ntsuam ntawm
  • Software vendors
  • Zog start-ups
  • Tuam txhab uas muag solar tuam txha
  • Zej zog xaiv Aggregators
  • Thov teb
  • Tsheb fais
  • Thiab ntau dua

Muab kuv cov ntaub ntawv ua pov thawj

Cov kev pab cuam ntawm Share Kuv Cov Ntaub Ntawv Yog Dab Tsi?

 

Cov neeg muas zaub tsis tau log rau lawv tus account hauv internet pheej download thiab xa ntsuab Button ntaub ntawv. Tiag mas, ib zaug ib tug neeg tso cai rau koj lub tuam txhab mus saib tau lawv cov ntaub ntawv PG&E, qhov hloov mus yog kov automatically thiab pheej siv cov qauv kawm raws li cov kev pab cuam Programming Interfaces (APIs). Muab kuv cov ntaub ntawv platform pob khoom tuaj rau cov neeg muas zaub cov ntaub ntawv, notifies koj lub cev thaum cov ntaub ntawv yog npaj thiab ruaj ntseg xa nws.

 

Txhim khu kev qha

Zoo ib yam, txhim khu kev qha cov ntaub ntawv los ntawm APIs. Tsis muaj "screen scrape" los yog download cov ntaub ntawv lawm.

 

Txheem APIs

Nationally pom tau hais tias txheem zog Service Interface API daim ntawv rau interoperability nrog lwm cov neeg zov me nyuam zog.

 

Billing thiab tus account

PG& E cov neeg muas zaub yuav tso cai rau lawv cov nqi kho mob thiab cov nyiaj hauv tuam txhab tso cai thiab.

 

Cov ntaub ntawv muaj nuj nqis thiab zoo

Saib tag nrho peb thiab billing cov ntaub ntawv los ntawm ib qhov chaw xwb.

 

Hluav Taws Xob thiab cov nkev

Muab kuv cov ntaub ntawv muaj pg&E cov ntaub ntawv rau ob hluav taws xob thiab roj siv.

 

Qhib innovation

Siv cov ntaub ntawv tsuas yog koj lub tswv yim (thiab ob peb lo lus thiab tej yam kev mob).

 

Tau pib nrog share kuv cov ntaub ntawv

Muaj ntau txoj kev mus saib tau cov neeg muas zaub-tso cai ntawm API. Peb tseeb APIs ua raws li cov tam sim no North American zog Standards Board (NAESB) zog Service Interface (ESPI) txheem thiab muab rau zog usage information (EUI) los ntawm ib txheej RESTful interfaces.

 

Tab sis ua ntej tshaj, koj yuav tsum sau npe siv cov ntaub ntawv platform ua ntej cov neeg muas zaub yuav tso cai rau koj saib lawv cov ntaub ntawv. Ua raws li cov kauj ruam nram qab no.

Ua ntej koj pib sau npe, nco ntsoov hais tias koj muaj cov lus qhia nram qab no.

 

  • SE ID: Koj tus 9-digit U.S. Tug Tswv Hauj Lwm Identification Nab Npawb (EIN)
  • Lag luam thiab Kev Sib Cuag
  • Uniform Resource Identifiers (URIs): Muab kuv cov ntaub ntawv Platform utilizes OAUth2.0 protocol rau kev tso cai. Yog hais tias tus neeg siv hom koj xaiv yuav tsum tau peb-legged OAuth mus saib tau cov ntaub ntawv, koj yuav tau muab valid URIs ua ntej peb yuav txais koj daim ntawv tso npe.
    Kawm ntxiv txog kev kuaj kom paub meej
  • URI : Koj yuav tau muab ib daim Ntawv Ceeb Toom Rau Kev Ceeb Toom (Notification) KOM peb lub nruab nrog cev yuav qhia tau rau koj thaum koj cov ntaub ntawv thov kev pab npaj muaj tub ceev xwm.
    Kawm ntxiv txog daim ntawv ceeb toom URL rau cov ntaub ntawv access tab sis
  • Ruaj ntseg Hypertext Transfer Protocol (HTTPS): Koj yuav tau txais ib daim ntawv qhia txog TLS1.2 X.509 daim ntawv pov thawj los ntawm ib tug neeg zov me nyuam SSL. Daim ntawv pov thawj muag khoom yuav tsis txais thiab submission ntawm ib self-kos npe rau SSL daim ntawv pov thawj yuav ncua qhov kev tso cai ntawm koj daim ntawv tso cai.

Qhia Kuv Cov Ntaub Ntawv Sau Npe Rau Kev Tso Cai rau koj qhia koj tus kheej rau PG&E ua ib lub tuam txhab—los yog lwm qhov chaw—uas xav mus saib tau cov ntaub ntawv neeg-tso cai thiab teeb rau peb APIs. Muaj plaub hom neeg siv hom rau share kuv cov ntaub ntawv. Xaiv tus neeg siv hom kev pab kom koj thiaj li muaj tau.

 

  • Txheem neeg siv: Ib tug txheem thib peb tog neeg siv. Sau Npe: Standalone
  • Tus Neeg Siv Kev Siv Rau Tus Kheej: Ib tug neeg sawv cev rau ib tug neeg los yog tus sawv cev rau ib qhov chaw-thov kev pab rau koj tus kheej.
  • Zog-Efficiency hais txog nyiaj txiag: ib lub koom haum uas muab kev pab hais txog on-bill repayment, on-bill hais txog nyiaj txiag los yog thaj zog-efficiency hais txog nyiaj txiag
  • Zej zog xaiv Aggregator: Ib lub zej zog sau npe xaiv Aggregator (CCA) hauv PG&E qhov chaw uas zoo heev. Xyuas daim ntawv uas tam sim no sau npe CCAs, mus xyuas zej zog xaiv Aggregation.

Thaum koj tau sau tag nrho cov hais, sau npe rau hauv feem ntawm kuv cov ntaub ntawv API Portal.

Cov ntaub ntawv thov thiab cov lus teb yog siv cov HTTPS protocol thiab authenticated ntawm ib ob-txoj kev certificate txauv nrog PG& E. Koj yuav tau siv cov ntawv pov thawj ruaj ntseg rau kev ruaj ntseg ua txhua yam thiab outbound API sib txuas lus.

Koj kuj yuav tau tswj unexpired, unrevoked RSA daim ntawv pov thawj nrog ib tug pej xeem tseem ceeb ntev tsawg kawg yog 2048 bits. Daim Ntawv Pov Thawj SSL Certificate yog ib prerequisite los sau qhov kev kuaj ntawd, ces thov kom koj daim ntawv pov thawj yog npaj txhij thiab muaj. PG& E tam sim no txhawb XWB SHA-2 X.509 daim ntawv pov thawj tawm los ntawm reputable daim ntawv pov thawj tub ceev xwm (PG& E tsis txais nws tus kheej kos npe), xws li AddTrust, Comodo, DigiCert. Entrust, GlobalSign, mus daddy,USERTrust thiab VeriSign.

Raws li ib tug neeg siv feem ntawm kuv cov ntaub ntawv, koj yuav tsum pom zoo rau PG&E feem kuv cov ntaub ntawv cov ntsiab lus thiab tej yam kev mob, thiab raws li acknowledge california Public Utilities Commission txoj cai tsis pub twg paub.

Download Share kuv cov ntaub ntawv terms thiab tej yam kev mob (PDF, 175 KB)
Download Privacy thiab ruaj ntseg tiv thaiv rau zog usage data (PDF)

 

Paub meej tias email chaw nyob

Thaum xa koj daim ntawv sau npe hauv internet, peb yuav xa ib tug email rau lub lag luam hu email chaw nyob. Qhov no yuav qhia tau tseeb tias peb muaj cov ntaub ntawv kho mob. Thov xaiv qhov txuas muaj nyob rau hauv no email tsis pub dhau tsib hnub ntawm receipt. Yog hais tias koj tsis, koj yuav tau resubmit hauv internet sau npe. Thaum koj paub tseeb hais tias koj qhov chaw nyob, peb yuav sau koj daim ntawv tso npe.

Lub hom phiaj ntawm txoj kev kuaj no yog los xyuas kom meej tias koj yuav txuas nrog peb lub nruab nrog cev. Thaum peb tau rov muab koj cov ntaub ntawv sau npe, peb yuav xa ib tug email qhia rau koj tias koj yuav pib kuaj. Muaj peb components rau tag nrho txoj kev kuaj tag nrho:

  • API Connectivity kuaj
  • OAuth Testing
  • Application Information Resource Thov

Mus kuaj cov lus qhia

lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Koj yuav tsum tau mus kuaj tsis pub dhau 90 hnub tom qab koj tau txais daim ntawv ceeb toom.

Thaum kuaj tiav lawm, koj yuav tau txais ib tug email uas kuaj tau ntse tiav. Tom qab ntsuam xyuas kawg, tus txheej xwm ntawm koj daim ntawv tso cai yuav raug txav mus rau Pom Zoo. Txij ntawm no mus, koj muaj peev xwm saib tau cov ntaub ntawv thiab, yog hais tias koj tus neeg siv kev tso cai rau koj mus saib tau ib tug neeg cov ntaub ntawv, cov neeg muas zaub yuav tau muab koj cov ntaub ntawv tso cai. Ntxiv thiab, cov neeg muas zaub tso cai rau lawv cov ntaub ntawv yuav tau saib tias koj lub koom haum tau mus saib tau. Yog hais tias koj xav kom disable neeg visibility, tej zaum koj yuav ua tau li ntawd los ntawm qhov chaw nres nkoj thib peb tog portal.

Yog xav paub ntxiv txog txoj kev tso cai, thov mus saib cov neeg muas zaub Tso Cai Overview nplooj ntawv.

Mus tso cai kom paub meej tias

Prerequisites

Cov nram qab no prerequisites yuav tsum tau ntsib ua ntej koj yuav saib tau peb APIs:

 

  1. Koj yuav tsum sau npe siv cov ntaub ntawv platform ua ntej cov neeg muas zaub yuav tso cai rau koj saib tau lawv cov ntaub ntawv. Yog koj tsis muaj npe sau npe, thov sau npe thiab sau ntawv.
  2. Koj yuav tsum tau txais ib tug email qhia rau koj tias koj daim ntawv tso npe tau txais. Yog koj tsis tau txais no email, thov log rau koj feem ntawm kuv tus account hauv koj cov ntaub ntawv account thiab xaiv "Tswj Registration" saib koj daim ntawv tso npe thov.

 

Nws tseem ceeb heev uas yuav tau kuaj seb koj daim ntawv txais npe txais yuav tau txais. Yog koj tsis tau mus kuaj li 90 hnub, koj daim ntawv sau npe yuav tshwm sim thiab koj yuav tau rov kuaj dua.

 

lub cim kev ceeb toom qhia paub uas tseem ceeb Tseem ceeb: Nrog rau qhov kos ntawm browser redirects thaum OAuth 2.0, tag nrho lwm yam kev thov ntawm koj thiab PG&E yog dua kev sib nrig sib SSL thiab yuav tsum tau koj txuas koj tus neeg tau txais kev pab SSL daim ntawv pov thawj rau koj thov. (Qhov no yuav tsum tau tib daim ntawv pov thawj uas koj xa mus rau PG&E ua ntej yuav txais.)

Cov neeg siv hauv qab no yuav tsum tau ua kom tiav API Connectivity kuaj:

Txheem neeg siv, self Access, zog Efficiency hais txog nyiaj txiag thiab zej zog xaiv Aggregator

Laj Thawj:

Lub hom phiaj ntawm qhov kev kuaj API Connectivity yog los xyuas kom meej tias koj yuav tau txuas nrog cov ntaub ntawv qhia kuv cov ntaub ntawv APIs.

Pom zoo: Retrieving Client Access Token siv XAB UI
Qauv kauj ruam ua tus thawj kauj ruam ntawm connectivity kuaj (retrieving ib tug neeg tau txais kev pab Token) siv XAB UI Tool.
Download TAU LUB XAB NPUM UIOlol (PDF, 520 KB).

Raws li kev siv yuav sib txawv, qhov no yog npaj tsuas yog ib tug siv los pab illustrate li cas API sib txuas rau PG&E yuav tsum tau ua dua kev sib nrig sib (2-txoj kev) SSL.

API Connectivity Test Steps:

Yuav tau pib, download PG&E entrust SSL Certificate los ntawm logging rau koj tus account. Ces xaiv "Tswj Registration" retrieve koj

sau npe milestones

Siv cov peev xwm mus nrhiav tau ib tug neeg tau txais kev pab mus saib tau:

  • Ua ib daim ntawv thov kev tso cai rau kev tshuaj ntsuam cov kev tso cai kuaj pom zoo Rau Kev Tshuaj Ntsuam: https://api.pge.com/datacustodian/test/oauth/v2/token
  • Ntxiv parameter grant_type=client_credentials.
  • Ntxiv yooj yim Authorization header parameter los Base64 encoding "client_ID:client_Secret." Tus header parameter yuav nyob rau hauv daim ntawv, hauv qab no:
    Param lub npe: Kev Tso Cai
    Param tus nqi : Yooj yim "base64encoded txoj hlua"
  • Cov lus teb yuav muab koj tus neeg tau txais kev pab token thiab nws expiry lub sij hawm (piv txwv li):
         
          c03a9825-16f7-400a-b546-9a206ab95db
          3600
          < >3
          Bearer
         

Siv tus neeg tau kev pab mus nrhiav kev pab hu rau qhov kev pab raws li txoj cai API:

  • Ua ib daim ntawv thov kom tiv thaiv no URL:
    https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ReadServiceStatus
  • Dhau tus neeg tau txais kev pab token hauv lub taub hau header hauv daim ntawv, hauv qab no:
    Header param npe = Authorization
    Tus nqi = Bearer
  • Cov lus teb yuav tsum ua raws li nram no:
         
          1
         

Siv tus neeg tau txais kev pab los mus thov cov qauv no:

  • Ua ib daim ntawv thov kom tiv thaiv no URL:
    https://api.pge.com/GreenButtonConnect/espi/1_1/resource/DownloadSampleData
  • Dhau tus neeg tau txais kev pab token hauv lub taub hau header hauv daim ntawv, hauv qab no:
    Header param npe = Authorization
    Tus nqi = Bearer
  • Cov lus teb yuav tsum ua raws li: Download Meter nyeem ntawv piv txwv (XML, 273 KB)

    Koj yuav tau ua tiav API Connectivity kuaj thaum koj muaj ntse tau txais cov ntaub ntawv qauv thiab koj yuav pom ib qho "API Connectivity Test: Tiav"milestone nyob rau hauv daim ntawv sau npe milestone rooj raws li muaj nyob rau hauv qab no.

sau npe milestones 2

Cov neeg siv yuav tsum tau ua kom tiav OAuth kuaj:

Txheem neeg siv thiab zog Efficiency hais txog nyiaj txiag

Laj Thawj:

Lub hom phiaj ntawm qhov kev kuaj OAuth yog los xyuas kom meej tias koj OAuth siv tej hauj lwm kom yog.

lub cim kev ceeb toom qhia paub uas tseem ceeb Lus Cim Tseg:

Rau lub hom phiaj ntawm qhov kev tshuaj ntsuam no, koj daim ntawv thov yuav tsum tau taw tes qhia rau tom qab endpoints thiaj li thov tau qhov "kev tshuaj ntsuam tso cai" thiab qhov "test token":

  • Kev tshuaj ntsuam authorizationServerAuthorizationEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/authorize
  • Kev tshuaj ntsuam authorizationServerTokenEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/token

OAuth Test Directions:

  • Log-in rau feem kuv cov ntaub ntawv thib peb tog Portal
  • Nyem "Go>" nyob rau hauv qhov kev kuaj ntawd OAuth kuaj
  • Qhov kev kuaj ntawd OAuth yuav qhib rau lub qhov rais tshiab. Nco ntsoov tias yog hais tias nws tsis qhib thov kom koj muaj pop-up blocker muab tua los yog xiam oob qhab.
  • Xaiv PIB: Yog xaiv pib koj yuav pib lub OAuth Test thiab kho yuav ua raws li cov theem ntawm redirects.

    ShareMyData OAuth kuaj:

    Teeb meem ib 302 redirect rau lub OAuth URL (ThirdPartyPortalURI) uas koj muab thaum Registration, nrog dummy scope parameters:
    Piv txwv li: {ThirdPartyPortalURI}?scope=xxx&thirdPartyID={dataCustodianId}

    Koj Daim Ntawv Thov Kev Pab:

    Xaiv: Koj Daim Ntawv Thov: Prompts (cov neeg muas zaub) mus login rau koj daim ntawv thov lub website

    Koj Daim Ntawv Thov Kev Pab:

    Teeb meem ib 302 redirect rau lub thiab ua tau ib daim ntawv thov kev tso cai rau daim ntawv tso cai Code:

    Piv txwv li, siv qhov txuas mus kuaj xwb:

    TAU https://api.pge.com/datacustodian/test/oauth/v2/authorize?client_id={clientID tus nqi nyob rau hauv RegistrationMilestones}&redirect_uri={redirect_uri}&scope={scope}&response_type=code

    Piv txwv li, siv qhov txuas rau NTAU LAWM XWB:

    TAU https://sharemydata.pge.com/myAuthorization?client_id={clientID tus nqi nyob rau hauv RegistrationMilestones}&redirect_uri={redirect_uri}&response_type=code&{optionalState}

    ShareMyData OAuth kuaj:

    Teeb meem ib 302 redirect rau lub uas koj tau muab thaum sau npe nrog lub dummy Authorization Code:

    Piv txwv li: https://thirdparty.com/redirectUrl?authorization_code=7afc7c4f-778a-4ad8-8337-5e19218a2219

    Koj Daim Ntawv Thov Kev Pab: Ua ib daim ntawv Thov Kev Pab Rau Kev Siv Daim Ntawv Tso Cai Los ntawm Kev Siv Daim Ntawv Tso Cai (Authorization Code) tau txais thiab hu rau lub :

    lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Rau qhov kev thov Kev Pab Uas Koj yuav tsum tau rhais koj daim SSL Certificate.
    Piv txwv li:

    NCEJ: https://api.pge.com/datacustodian/test/oauth/v2/token?grant_type=authorization_code&code={authorizationcode}&redirect_uri={redirect_uri}

    Ntxiv yooj yim Authorization header parameter los Base64 encoding "client_ID:client_Secret"

    Tus header parameter yuav nyob rau hauv cov ntawv nram qab no:

    • Param lub npe: Kev Tso Cai
    • Param tus nqi : Yooj yim "base64encoded txoj hlua"

    ShareMyData OAuth kuaj: Teb nrog ib txoj kev kuaj access Token:

    Ib lo lus teb zoo yuav zoo li no:
    "access_token":" 774ff105-7ad5-40c8-a6ec-f60675dc0e41"
    "expires_in":"3600"
    "refresh_token":998c6654-5b3b-4385-af4f-4e5c46c1b04
    "Scope": "{ScopeString}"
    "ResourceURI":"{ResourceURI}"
    "authorizationURI":"{AuthorizationURI}"
    "token_type":"bearer"

Txij ntawm no mus, koj yuav muaj ntse tiav cov OAuth kuaj thiab koj yuav pom ib qho "OAuth kuaj: Tiav"milestone nyob rau hauv daim ntawv sau npe milestone rooj raws li muaj nyob rau hauv qab no:

sau npe milestones

lub cim kev ceeb toom qhia paub uas tseem ceebTseemCeeb: Thaum koj kuaj, koj yuav tsum tau rov muab koj daim ntawv tso npe thov kev pab rau qhov ntau lawm Endpoints rau Kev Tso Cai Thiab Kev Thov Kev Pab Rau Cov Neeg Muas Zaub kom tso cai rau koj mus saib tau lawv cov ntaub ntawv. Cov lus xaus no yuav muab rau koj hauv Daim Ntawv Thov Kev Pab Rau Cov Neeg Muab Kev Pab ( Application Information Resource Resource).

Cov neeg siv hauv qab no yuav tsum tau ua Daim Ntawv Thov Kev Pab Rau Cov Neeg Muab Kev Pab:

Txheem neeg siv thiab zog Efficiency hais txog nyiaj txiag

Laj Thawj:

Lub hom phiaj ntawm daim ntawv Thov Kev Pab (Application Information Resource Request) yog los xyuas kom koj tau txais cov URLs rau kev tso cai rau cov kev tso cai thiab cov kev tso cai rau Cov Neeg Ua Hauj Lwm pab tswv yim nrog rau cov ntaub ntawvCustodianScopeSelectionScreenURI

Cov Kev Pab Rau Cov Neeg Muab Kev Pab Cov Kev Pab:

Koj yuav tau txais koj daim Ntawv Sau Npe Thov Kev Pab Rau Kev Sau Npe Thov Kev Pab (Application Information) Daim Ntawv Thov Kev Pab.

Retrieve Sau Npe Mus Saib Token

Retrieve koj daim ntawv sau npe Mus Saib Token log rau koj feem ntawm kuv cov ntaub ntawv nyiaj thiab xaiv "Tswj Registration." Koj yuav muab tso tawm rau hauv daim ntawv sau npe Milestone thaum koj sau npe.

sau npe milestones

Retrieve Application Information ID

Siv tus neeg tau txais kev pab mus saib tau retrieved thaum API Connectivity kuaj hu rau daim ntawv tso cai xml:
Ua ib daim ntawv thov kom tiv thaiv no URL:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization

Dhau tus neeg tau txais kev pab token hauv lub taub hau header hauv daim ntawv, hauv qab no:
Header param npe = Authorization
Tus nqi = Bearer
Nyob rau lo lus teb koj yuav saib daim ntawv thov kev pab (Application ID):

sau npe milestones

Thov Kom Muaj Kev Pab Rau Cov Neeg Muab Kev Pab

Hu rau Application Information endpoint nrog GET rau hauv qab no: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ApplicationInformation/{ApplicationInformationID}.
Hloov {ApplicationInformationID} nrog rau daim ntawv thov ID koj retrieved
Ntxiv Cov lus qhia txog kev tso cai header parameter. Tus header parameter yuav nyob rau hauv daim ntawv, hauv qab no:

Param lub npe: Kev Tso Cai
Param tus nqi : Bearer
Cov lus teb yuav muab koj daim ntawv thov kev pab rau koj

lub cim kev ceeb toom qhia paub uas tseem ceebTseem ceeb: Rau cov lus qhia uas yuav ua li cas thiaj li yuav ua tau daim ntawv kos npe, thov saib daim ntawv cog lus Ntsuab Khawm Daim Ntawv Pom Zoo.

Cov Lus Qhia Txog Kev Pab Rau Cov Neeg Muab Kev Pab Yuav Muaj raws li nram qab no:

  • DataCustodianId
  • DataCustodianApplicationStatus
  • ThirdPartyApplicationDescription
  • ThirdPartyApplicationType
  • thib pebPartyPhone
  • authorizationServerUri
  • thirdPartyNotifyUri
  • authorizationSerAuthorizationEndpoint
  • authorizationServerTokenEndpoint
  • dataCustodianBulkRequestURI
  • dataCustodianResourceEndpoint
  • ThirdPartyScopeSelectionScreenURI
  • ThirdPartyUserPortalScreenURI
  • client_secret
  • client_name
  • redirect_uri
  • client_id
  • software_id
  • software_version
  • client_id_issued_at
  • client_secret_expires_at
  • kev sib cuag
  • token_endpoint_auth_method
  • tau taub
  • grant_types
  • grant_types
  • grant_types
  • response_types
  • registration_client_uri
  • registration_access_token
  • DataCustodianScopeSelectionScreenURI

Yog hais tias koj yog ib tug neeg siv txheem los yog zog Efficiency hais txog nyiaj txiag, qhov no yog qhov kawg ntawm peb kuaj, thiab, tom qab ntsuam xyuas, koj daim ntawv sau npe yuav raug tsiv mus nyob rau hauv qab no. Nrog rau ib daim ntawv tso cai pom zoo rau cov neeg muas zaub yuav tam sim no tso cai rau koj mus saib tau lawv cov ntaub ntawv ntawm lawv tus account zog, los yog ntawm redirect thru koj lub website siv lub muab rau koj nyob rau hauv Daim Ntawv Thov Kev Pab Cuam Thov.

lub cim kev ceeb toom qhia paub uas tseem ceebTseem ceeb: Koj yuav tsum tau rov qab thov koj daim ntawv tso npe rau qhov ntau lawm Endpoints rau Kev Tso Cai Thiab Kev Thov Kev Pab Rau Cov Neeg Muas Zaub kom tso cai rau cov neeg muas zaub kom tso cai rau koj mus saib tau lawv cov ntaub ntawv. Cov lus xaus no yog muab rau koj hauv Daim Ntawv Thov Kev Pab Cuam Rau Cov Neeg Muab Kev Pab.

sau npe milestones

Yog xav paub ntxiv txog li cas cov neeg muas zaub grant thib peb ob tog mus saib tau lawv cov ntaub ntawv mus xyuas cov lus qhia.

Thaum koj tau txais kev tso cai, tej zaum koj yuav pib utilizing peb APIs mus saib tau cov ntaub ntawv tso cai. Yog xav paub ntxiv, mus saib tau cov ntaub ntawv.

Prerequisites

Cov nram qab no prerequisites yuav tsum tau ntsib ua ntej koj yuav saib tau peb APIs:

 

  1. Koj yuav tsum sau npe siv cov ntaub ntawv platform ua ntej cov neeg muas zaub yuav tso cai rau koj saib tau lawv cov ntaub ntawv. Yog koj tsis muaj npe sau npe, thov sau npe thiab sau ntawv.
  2. Koj yuav tsum tau ua tiav API Connectivity thiab OAuth Testing. Yog koj tsis tau mus kuaj tiav, thov mus saib qhov kev kuaj ntawd.
    lub cim kev ceeb toom qhia paub uas tseem ceeb Faj seeb: Cov OAuth kuaj kauj ruam yuav muab kho rau lub neej yav tom ntej tso kom muaj tseeb OAuth 2.0 functionality piav hauv qab no (i.e., tshem tawm ntawm thirdPartyScopeSelectionScreenURI).
    Mus xyuas kom paub meej

Kev Tso Cai

Yuav kom ua raws li cov qauv North American zog Standards Board (NAESB) zog Service Interface (ESPI) txheem rau kev tso cai, PG&E tau DVR OAuth 2.0 Tso cai framework rau kev tso cai rau cov ntaub ntawv. Cov diagram hauv qab illustrates li cas cov neeg muas zaub pib tso cai, xaiv cov parameters thiab ces xa lawv cov kev tso cai.

Lwm cov ntaub ntawv siv dhau hauv qab no:

Download lub ESPI OAuth 2.0 Sequence Diagram (PDF, 193 KB)
saib cov ntaub ntawv ntsuab Khawm cov ntaub ntawv SDK ntawm Github

lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Rau lub zej zog xaiv Aggregators, tsuas yog client_access_token yuav tsum tau thov cov ntaub ntawv (ntawm 2-Legged OAuth) thiab cov nram qab no tsis siv.

Diagram of Authorization process initiated at a third-party site

Diagram of authorizations initated at PG&E

Cov kauj ruam uas thov kev tso cai

Cov kev tso cai pib ntawm tus neeg thib peb qhov chaw

Pib ib qho kev tso cai los ntawm ib feem peb tog li illustrated hauv tus thawj diagram saum toj no, Ib daim ntawv tso cai thov yog los ntawm redirecting tus neeg browser ntawm koj tog thib peb qhov chaw pg&E Authorization Endpoint URL nrog tsim nyog thov parameters li piv txwv hauv qab no. Raws li redirection, cov neeg muas zaub yuav tau hais ib PG&E log-in page rau authentication, raws li ib nplooj ntawv tso cai rau cov ntaub ntawv tso cai rau koj tog thib peb:

authorizationSerAuthorizationEndpoint URI (nrog thov parameters)
https://sharemydata.pge.com/myAuthorization?client_id=A1b2C3&redirect_uri={redirect_uri}&response_type=code&{optionalState}

  • Mandatory Thov Parameters:
    • client_id = Client ID los ntawm koj cov ntaub ntawv sau npe milestones (i.e., client_id/client_secret khub).
    • redirect_uri = redirect URL uas koj specified hauv koj daim ntawv sau npe (URLs yuav tsum phim).
      lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Peb xav kom URL encoding yuav tsum ua ntawv thov redirect_uri raws li ib qho piv txwv hauv qab no.
    • response_type = code (static tus nqi)
  • Optional Request Parameter (s):
    • Lub xeev = optional opaque xeev parameter raws li pub los ntawm tus OAuth 2.0 txheem uas yuav rov qab nrog rau qhov kev tso cai thiaj li yuav pab tswj tau lub xeev. Piv txwv li, lub xeev parameter tej zaum yuav siv los ntawm ib feem peb tog rau uniquely qhia cov neeg muas zaub keeb kwm thiab tiv thaiv cross-site forgery.
    • login={qhua} Muab qhov kev xaiv rau ib feem peb tog los redirect cov neeg muas zaub los xws li PG&E kuv lub zog log‐nyob rau hauv los yog rau tus qhua Access tab sis ua ib feem ntawm cov kev tso cai hauv internet txaus.

PIV TXWV LI: Auth code thov

TAU: https://sharemydata.pge.com/myAuthorization?client_id=A1b2C3&redirect_uri=https%3A%2F%2Fthirdparty.com%2FredirectUrl&response_type=code&state=pge12advertisement

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Piv txwv li redirect_uri parameter saum toj no muaj URL encoding thov (i.e. URL encoding of https://thirdparty.com/redirectUrl)

Yog hais tias koj ua ib daim ntawv thov kom saum toj no, thiab cov neeg muas zaub ntse authenticates thiab tso cai, cov neeg muas zaub yuav tom qab tau muab tso cai rau koj redirect_uri nrog rau daim ntawv tso cai, (tso cai) tau parameter, thiab xaiv lub xeev parameter (yog muab los ntawm kev tso cai) raws li nram qab no:

https://thirdparty.com/redirectUrl?authorization_code=7afc7c4f-778a-4ad8-8337-5e19218a2219&scope=FB=1_3_8_13_14_18_19_31_32_35_37_ 38_39_40_4_5_10_15_16_46_47; Ntxiv Tau Txais Kev Pab Ntxiv Mus Usage_Billing_Basic_Account_ProgramEnrollment; IntervalDuration=900_3600; BlockDuration=daily; Keeb kwmLength={3P Registered keeb kwm length}; AccountCollection={suav ntawm tso caiAs};BR={ThirdPartyID}; dataCustodianId=PGE & xeev=pge12advertisement

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Daim ntawv tso cai Yog short-lived (expires hauv 600 vib nas this), thiab yuav tsum tau tom exchanged rau ib access token/refresh token khub kom tiav cov kev tso cai thiab tso cai rau cov ntaub ntawv mus saib tau. Saib sab tom ntej (Section 2) kom paub meej txog cov Access Token/ Refresh Token thov.

Qhov (tso cai) tau parameter piv txwv saum toj no yog xa raws li ib feem ntawm cov lus teb rau daim ntawv Tso Cai Thov, tus Access Token Request, thiab raws li daim ntawv Tso Cai API. Qhov no parameter tso cai rau kev sib txuas lus kawg ntawm cov neeg muas zaub tso cai. Particular, cov parameter muaj xws li ib tug "NtxivScope" tus nqi uas maps rau PG&E tus txaus siab rau cov ntaub ntawv xaiv cov ntaub ntawv (e.g., "Usage", "Billing", "Basic", "Account", "Program"). Qhov tseem ceeb parameter qhov tseem ceeb yog ntxiv yuav ib cov ntaub ntawv raws li cov ntaub ntawv: Download Txaus siab block Scope string Mapping Click Thru 2.0 (PDF, 222 KB).

Yuam kev Scenarios

Thib peb tog Implementation Errors: Yog hais tias tus yuav tsum tau thov parameters ntawm client_id los yog redirect_uri yog invalid los yog uas ploj lawm raws li thov ib qho kev tso cai, cov neeg muas zaub yuav tau qhia ib qho explanatory lus nrog rau tus txheem HTTP 400 series yuam kev. Mob(nurses), yog hais tias tus yuav tsum tau thov parameter ntawm response_type yog uas ploj lawm los yog invalid, cov neeg muas zaub yuav tsum redirected rov qab mus rau koj redirect_uri nrog lub OAuth 2.0 txhais "invalid_request" yuam kev parameter thiab raws li lub xeev cov parameter yog xub muab ua ib feem ntawm cov thawj daim ntawv tso cai thov.

Cov neeg muas zaub Declining tso cai: raws li ib feem peb tog redirecting ib tug neeg muas zaub tso cai nrog PG& E, ib tug neeg muas zaub muaj qhov kev xaiv poob ntawm ib "cancel" khawm ntawm ob lub log-in nplooj ntawv thiab cov nplooj ntawv tso cai. Tej zaum, cov neeg muas zaub yuav tsum redirected rov qab mus rau koj redirect_uri nrog lub OAuth 2.0 txhais "access_denied" yuam kev parameter appended qhia cov neeg declined tso cai. Tsis tas li, lub xeev cov parameter yuav muab rov qab yog hais tias xub muab ua ib feem ntawm cov kev tso cai thawj zaug.

Cov Kev Tso Cai Pib ntawm PG&E

Thaum cov neeg muas zaub pib rau PG&E tus neeg web portal, "Koj tus account," thiab ces navigate rau feem kuv cov ntaub ntawv yuav tsaws nplooj ntawv, lawv yuav hais ib dropdown ntawm sau npe thiab pom peb ob tog. Raws li illustrated nyob rau hauv cov diagram thib ob saum toj no, raws li ib tug neeg xaiv ib feem peb tog ntawm daim ntawv uas sau npe thib peb tog thiab xaiv "Tom ntej no," cov neeg muas zaub yuav tsum redirected rau tus neeg thib peb tog sau npe "Thib peb tog Portal URI," uas taw tes rau cov neeg muas zaub yuav npaj nrog tus thib peb tog teg num OAuth txheej txheem piav nyob rau hauv cov preceding seem.

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Ib txhia ob tog tau nug txog yuav streamline cov neeg muas zaub kev siv rooj plaub no (i.e., tso cai rau PG&E qhov chaw) xws li cov neeg muas zaub nws zoo nkaus li lawv noj ncaj qha mus rau ib nplooj ntawv tso cai raws li xaiv ib feem peb ntawm tus dropdown. Pab txhawb tej tus neeg muas zaub kev, peb ob tog yuav xaiv teev lawv "Thib peb tog Portal URI" (ntawm qhov muab kuv cov ntaub ntawv tswj sau npe) rau ib endpoint uas automatically redirects cov neeg muas zaub rov qab mus PG&E ua ib feem ntawm ib daim ntawv tso cai thov. Thaum automatic redirect rov qab mus PG&E daim ntawv tso cai Tso Cai Endpoint, cov neeg muas zaub yuav hla cov neeg muas zaub login (raws li lawv twb logged) thiab yuav ncaj qha mus rau cov nplooj ntawv tso cai. Rau ib co thib peb tog uas tau sau npe ua ntej qhov muab kuv cov ntaub ntawv Click Thru 2.0 tso rau lub rau hli ntuj xyoo 2018, Qhov no yuav tau accomplished los tsuas defining tus thib peb tog Portal URI mus sib npaug zos tsis siv "Thib peb tog Scope Selection Screen" URI (teb yuav tsum txijnkawm yav tom ntej tso).

Contrast, ib txhia ob tog yuav xav xub txuam yuaj thiab screen cov neeg muas zaub rau lawv sab thaum cov neeg muas zaub yog redirected rau lawv "Thib peb tog Portal" URI ua ntej thov ib daim ntawv tso cai code, ces saum toj no yog ib suggestion xwb.

Yuav kom tau ib qho Kev Pab Rau Kev Siv, siv daim Ntawv Tso Cai (Authorization Code) tau txais thiab hu rau hauv qab no nrog thov parameters raws li tau piav nyob rau hauv qab no. Raws li piav saum toj no, daim ntawv tso cai Tso Cai Yog luv luv, expiring tom qab 10 feeb (600 vib nas this), ces thov xyuas kom tus Access Token yog sai thov raws li tau txais kev tso cai.

authorizationSerAuthorizationEndpoint: https://api.pge.com/datacustodian/oauth/v2/token

  • Mandatory Thov Parameters:
    • grant_type = authorization_code (static tus nqi)
    • kev tso cai = kev tso cai tau txais kev tso cai teb rau cov kev tso cai
    • redirect_uri = redirect URL uas koj specified hauv koj daim ntawv sau npe (URLs yuav tsum phim).
      lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Raws li qhov kev tso cai, peb xav URL encoding yuav tsum thov kom lub redirect_uri.

Piv txwv li: Access Token thov
NCEJ: https://api.pge.com/datacustodian/oauth/v2/token?grant_type=authorization_code&code={authorizationcode}&redirect_uri={redirect_uri}

Ntxiv yooj yim Authorization header parameter nrog Base64 encoding thov "clientID:clientSecret"

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Tus clientId:clientSecret qhov tseem ceeb correspond rau tus neeg tau txais kev pab qhov tseem ceeb muab rau koj feem ntawm kuv cov ntaub ntawv sau npe milestones.
Tus header parameter yuav nyob rau hauv cov ntawv nram qab no:
Param lub npe: Kev Tso Cai
Param tus nqi : Yooj yim "base64encoded txoj hlua"

Ib lo lus teb zoo yuav zoo li no:


774ff105-7ad5-40c8-a6ec-f60675dc0e41
3600
998c654-5b3b-4385-af4f-4e5c46c1b04
scope=FB=1_3_8_13_14_18_19_31_32_35_37_38_39_40_4_5_10_15_16_46_47; Ntxiv Tau Txais Kev Pab Ntxiv Mus Usage_Billing_Basic_Account_ProgramEnrollment; IntervalDuration=900_3600; BlockDuration=daily; Keeb kwmLength={3P Registered keeb kwm length}; AccountCollection={suav ntawm tso cai SAs};BR={ThirdPartyID}; DataCustodianId=PGE
resourceURI:{ResourceURI} e.g.: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{subscriptionID}
authorizationURI:{AuthorizationURI} e.g.: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{authorizationID}
CustomerResourceURI:{customerResourceURI} e.g:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
Bearer

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Ib access Token expires hauv 3600 secs (1 teev), thaum lub corresponding Refresh Token expires hauv 1 xyoos. Saib tom ntej 3 kom paub meej txog kis tau ib tug tshiab Access Token/Refresh Token khub.

Txuag cov access thiab refresh token khub.
Thov pib keeb kwm yav tas los thiab mus tsis tu ncua txhua hnub, mus saib tau cov ntaub ntawv.

Raws li ib tug xyaum zoo, tus Access Token yog ib short-lived token (1 teev) thaum lub corresponding Refresh Token yog ib tug ntev-nyob token (1 xyoos) uas koj yuav siv tau ib tug tshiab Access Token/Refresh Token khub thaum lub Access Token expires. Yuav kom tau ib tug tshiab Access Token thiab Refresh Token khub rau uas twb muaj lawm-expired tso cai, siv cov "refresh Token" thiab hu rau hauv qab no endpoint nrog parameters li piav hauv qab no.

authorizationSerAuthorizationEndpoint: https://api.pge.com/datacustodian/oauth/v2/token ?grant_type= refresh_token&refresh_token={current_refresh_token}

PIV TXWV LI: Refresh Token thov
NCEJ: https://api.pge.com/datacustodian/oauth/v2/token?grant_type= refresh_token&refresh_token={current_refresh_token}

Ntxiv yooj yim Authorization header parameter nrog Base64 encoding thov "clientID:clientSecret"

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Tus clientId:clientSecret qhov tseem ceeb correspond rau tus neeg tau txais kev pab qhov tseem ceeb muab rau koj feem ntawm kuv cov ntaub ntawv sau npe milestones.
Tus header parameter yuav nyob rau hauv cov ntawv nram qab no:
Param lub npe: Kev Tso Cai
Param tus nqi : Yooj yim "base64encoded txoj hlua"

Ib lo lus teb zoo yuav zoo li no:
sib kho
"access_token": "677e6ef8-1e1a-43f0-85b8-5692fcbc72b2",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "0eef9a9f-60c6-40bb-b33f-910e32c0298",
"Tau": "tau=FB=1_3_8_13_14_18_19_31_32_35_37_38_39_40_4_5_10_15_16_46_47; NtxivScope=Usage_Billing_Basic_Account_
Programenrollment; IntervalDuration=900_3600; BlockDuration=daily; Keeb kwmLength={3P Registered keeb kwm length}; AccountCollection={suav ntawm tso cai SAs};BR={ThirdPartyID}; DataCustodianId=PGE",
"ResourceURI": "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/test",
"authorizationURI": "https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/test"
}

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Mob(nurses), tus neeg tau txais kev pab token yog ib short-lived token (1 teev) thaum nws corresponding Refresh Token yog ib tug ntev-nyob token (1 xyoos) uas koj yuav siv tau ib tug neeg tshiab Access Token/Refresh Token khub thaum tus neeg tau txais token expires. Yuav kom tau ib tug neeg tshiab Client Access Token/Refresh Token khub, siv cov kauj ruam tib yam piav saum toj no.

Updating thiab tswj cov kev tso cai

Cov neeg muas zaub yuav tau hloov lawv cov kev tso cai los ntawm kev ua raws li nram no:

  • Tshem Cov Kev Pab Uas Tau Tso Cai Rau Cov Neeg Muab Kev Pab IDs ntawm lawv cov kev tso cai
  • Extending hnub kawg ntawm lub sij hawm tso cai
  • Canceling cov kev tso cai

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Cov neeg muas zaub yuav tsuas tau hloov rau lawv cov kev tso cai los ntawm logging rau lawv hauv internet PG&E nyiaj thiab tom qab cov kauj ruam. Yog hais tias muaj tej yam li no, peb yuav qhia rau koj paub txog daim ntawv Ceeb Toom Uri uas koj tau muab sau npe rau thaum sau npe.

Muaj ntau txoj kev xaiv rau tswj thiab saib kom paub meej txog koj cov kev tso cai:

  • Koj hu tau rau API (http GET operation) siv koj client_access_token ntawm tus neeg thib peb (kom paub meej ntxiv txog tag nrho cov kev tso cai) ntawm https://api.pge.com/GreenButtonConnect /espi/1_1/resource/Authorization or ntawm tus neeg muab kev tso cai nyob rau theem ntawm https://api.pge.com/GreenButtonConnect /espi/1_1/resource/Authorization/AuthorizationID}.
  • Nyias, koj kuj pom ib tug neeg tso cai kom paub meej manually los ntawm logging rau koj feem kuv cov ntaub ntawv nyiaj ntawm tus neeg thib peb tog portal thiab nkag mus rau subscription ID rau cov kev tso cai uas koj nyob nraum searching rau.

Yog hais tias koj tsis xav mus saib tau cov ntaub ntawv uas muaj kev tso cai, nws muaj nws txoj kev uas yuav muab tso tseg:

  • Koj hu tau rau qhov kev tso cai uas tau kev tso cai API (http DELETE operation) siv koj client_access_token ntawm https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{AuthorizationID}.
  • Xwb, koj yuav manually cancel ib daim ntawv tso cai los ntawm logging rau koj feem kuv cov ntaub ntawv nyiaj ntawm tus neeg thib peb tog portal thiab nkag mus rau subscription ID rau cov kev tso cai uas koj xav kom muab tso tseg.

lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Cov neeg muas zaub yuav raug ceeb toom rau koj tias koj tau ua kom muab lawv cov kev tso cai. Tsis tas li, ib zaug ib qho kev tso cai yog lawm os, qhov txiav txim yuav tsis tau reversed.

Prerequisites

Cov nram qab no prerequisites yuav tsum tau ntsib ua ntej koj yuav saib tau peb APIs:

  1. Koj yuav tsum sau npe siv cov ntaub ntawv platform ua ntej cov neeg muas zaub yuav tso cai rau koj saib tau lawv cov ntaub ntawv.
  2. Koj yuav tsum tau ua tiav API Connectivity thiab OAuth Testing. Yog koj tsis tau mus kuaj tiav, thov mus saib qhov kev kuaj ntawd.
    Mus xyuas kom paub meej
  3. Yog hais tias koj tus neeg siv hom kev tso cai yuav tsum tau tso cai rau cov ntaub ntawv, thov xyuas kom meej tias cov neeg muas zaub tau tso cai rau koj mus saib tau lawv cov ntaub ntawv thiab tias koj muaj exchanged daim ntawv tso cai rau ib tug neeg siv kev pab. Yog hais tias koj tsis tau txais kev tso cai muab kev tso cai, thov saib cov neeg muas zaub tso cai.
    Mus tso cai kom paub meej tias

Lub Ntsiab Lus

Muaj ntau txoj kev mus saib tau cov neeg muas zaub-tso cai ntawm API. Peb tseeb APIs ua raws li cov tam sim no North American zog Standards Board (NAESB) zog Service Interface (ESPI) txheem thiab muab rau zog usage information (EUI) los ntawm ib txheej RESTful interfaces

Download txaus siab APIs (PDF, 217 KB)

Cov ntaub ntawv txaus siab APIs qhia tau hais tias cov APIs txaus siab los ntawm PG&E txoj kev siv feem ntawm kuv cov ntaub ntawv, thiab raws li tus PG&E specific API URL.

Download txaus siab ua hauj lwm thaiv tau txoj hlua mapping (PDF, 222 KB)

Cov kev txaus siab muaj nuj nqi block Scope string Mapping ntaub ntawv captures paub meej txog txoj hlua uas yog rov qab ua ib feem ntawm cov lus teb rau daim ntawv tso cai Code Thov, tus Access Token Thov, thiab raws li cov kev tso cai API raws li piav nyob rau hauv cov kev tso cai overview. Cov parameter pub rau kev sib txuas lus kawg ntawm cov neeg muas zaub tso cai. Tsis tas li, daim ntawv no uas ESPI txheem ua hauj lwm blocks PG&E share kuv cov ntaub ntawv siv.

Download txaus siab relational cov ntaub ntawv qauv (PG&E siv ESPI) (PDF, 482 KB).

Nyob rau hauv conjunction nrog cov ntaub ntawv Txaus siab cov ntaub ntawv elements, cov ntaub ntawv Txaus siab Relational Data Qauv illustrates li cas txoj kev sib raug zoo ntawm cov ntaub ntawv PG&E cov ntaub ntawv yog yuav los ntawm cov ESPI txheem.

Download txaus siab cov ntaub ntawv hais (PDF, 283 KB)

Cov ntaub ntawv txaus siab cov ntaub ntawv hais txog cov ntaub ntawv muab ib mapping ntawm cov NTAUB NTAWV ESPI txheem cov ntaub ntawv hais thiab PG&E cov ntaub ntawv hais.
PG&E txoj kev siv yog compatible nrog lub ESPI muab schema txhais cov ntsiab lus nyob rau GitHub. Specifically, peb tam sim no siv cov schema versions:

Download XSDs (ZIP, 50 KB)
mus xyuas Github

Thov siv raws li qhov kev pab nram qab no kom tiav cov kos npe rau txhua API thov thiab mus kuaj cov API hu rau GBC API Sandbox:

Mus xyuas cov ntsuab Button ntaub ntawv tsev qiv ntawv
mus xyuas cov ntsuab Button API

Ceeb Toom Uri

Thaum sau npe, koj yuav tau muab ib daim Ntawv Ceeb Toom Txog Kev Tso Cai (kom peb lub nruab nrog cev yuav qhia rau koj paub txog tej kev hloov hauv koj daim ntawv tso cai (e.g., cov neeg muas zaub cancellations), nyob rau hauv rooj plaub ntawm asynchronous ntaub ntawv thov (rau cov ntaub ntawv loj teev cia), thiab thaum twg koj cov ntaub ntawv thov kev pab yog npaj txhij. Nyias, yog hais tias koj xav tau txais txhua hnub subscription ntawv ceeb toom txog cov ntaub ntawv tsis ntev los no muaj cov ntaub ntawv ntxiv rau tej corrections yav dhau los los ntawm 24 teev, xaiv cov lus qhia rau kuv raws li cov ntaub ntawv yog npaj checkbox hauv koj daim ntawv sau npe. Peb yuav prepackage qhov tseeb hnub cov ntaub ntawv thiab ceeb toom rau koj ntawm koj daim ntawv ceeb toom URI rov qab los thiab retrieve cov ntaub ntawv.

lub cim kev ceeb toom qhia paub uas tseem ceeb Lus Cim Tseg: Yog hais tias koj tsis npaj siab retrieve cov ntaub ntawv rau txhua hnub, peb nug koj tsis mus xyuas cov lus qhia rau kuv raws li cov ntaub ntawv yog npaj kom txo tus nqi ntawm cov ntaub ntawv ruaj peb txheej txheem. Koj tseem yuav tau ua ib hoc thov kom cov ntaub ntawv.

  • PG& E yuav xa ntawv ceeb toom rau koj daim ntawv ceeb toom URI uas tau muab sau npe rau. Notifications comprise URIs corresponding twb prepackaged cov ntaub ntawv npaj rau koj rov qab los thiab thov ntawm tus muab URLs. Cov ntaub ntawv yog prepackaged thiab ntawv ceeb toom xa mus rau hauv cov nram qab no ob scenarios: (1) koj twb xaiv "Qhia rau kuv raws li cov ntaub ntawv yog npaj" nyob rau hauv koj daim ntawv sau npe profile, uas peb mam pob qhov tseeb txhua hnub nrog tej corrections rau hnub dhau los, los yog (2) koj twb ua ib tug ua ntej lawm hoc asynchronous thov kom cov ntaub ntawv thov yog tam sim no npaj txhij.
  • Scenario 1 yog illustrated nyob rau hauv cov "DATA ACCESS: NIAJ HNUB SUBSCRIPTION" seem ntawm cov ntaub ntawv Access Methods diagrams hauv qab no thiab Scenario 2 yog illustrated nyob rau hauv cov "DATA ACCESS: AD HOC REQUEST (ASYNCHRONOUS)" seem ntawm tib diagrams hauv qab no.

Cov Ntaub Ntawv Siv Rau Kev Siv

Data Access: Daily Subscription Model

Cov Ntaub Ntawv thov kev pab piv txwv

Thov nco ntsoov lub neej token lub neej ntawm tus Access Tokens, Client Access Token, thiab lawv corresponding Refresh Tokens siv nyob rau hauv cov ntaub ntawv thov. Raws li ib tug xyaum zoo, tus Access Token yog ib short-lived token (1 teev) thaum lub refresh token yog ib tug ntev-nyob token (1 xyoos) uas koj yuav siv tau kis tau ib tug tshiab Access Token/Refresh Token khub thaum lub Access Token expires. Mob(nurses), tus neeg tau txais kev pab Token yog ib short-lived token (1 teev) thaum nws corresponding Refresh Token yog ib tug ntev-nyob token (1 xyoos) uas koj yuav siv tau kis tau ib tug neeg tshiab Access Token/Refresh Token khub thaum tus neeg tau txais token expires. Yog xav paub meej ntxiv txog tau ib khub tshiab token, xa mus rau kauj ruam 3, Thov ib tug tshiab access token, nyob rau hauv peb cov kev tso cai tab sis. Mus tso cai kom paub meej tias

Yog koj tau kev tso cai los ntawm cov neeg muas zaub yuav tau txais "Account Information" (Account IDs, Service Agreement IDs and service start dates) thiab/los yog "Basic Information" (i.e., customer name and service address), koj thov tau tej ntaub ntawv qhia txog cov neeg muas zaub ntawm lub ESPI txhais tau hais tias retailCustomer APIs uas cov ntaub ntawv conforms rau lub schema, retailCustomer.xsd, muab saum toj no.

Synchronous (Standard thiab EEF thib peb tog)

Ib txoj kev mus thov cov neeg muas zaub yog siv cov synchronous API thov cov neeg muas zaub rau ib tug neeg muas zaub tso cai rau cov neeg muas zaub (i.e., khw muag khoom cov neeg muas zaub):

Piv txwv synchronous Thov URL: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{retailCustomerID}

RetailCustomerID = RetailCustomerID koj tau txais kawg ntawm lub OAuth tso cai sequence kom tau ib qho kev mus saib token. Tus RetailCustomerID yog ib feem ntawm cov neeg muas zaubResourceUri path parameter nyob rau hauv cov lus teb token. (RetailCustomerID=SubscriptionID)

HTTP Header = Authorization:Bearer {access token rau daim ntawv tso cai no}

Teb = koj yuav tau rov qab cov ntaub ntawv synchronously rau ntawd RetailCustomerID. Cov ntaub ntawv conforms rau lub khw muag khoomCustomer.xsd

lub cim kev ceeb toom qhia paub uas tseem ceebFaj seeb: Tus synchronous khw muag khoom neeg API yog ntawm tus neeg khw muag khoom cov neeg muas zaub uas corresponds rau ib tug neeg muas zaub xwb.

Rau kev siv: tus hierarchical diagram hauv qab no qhia tau hais tias txoj kev sib raug zoo hierarchy rau cov ntaub ntawv ESPI cov ntaub ntawv hais nyob rau hauv qauv PG&E cov ntaub ntawv.

Koj kuj thov tau cov ntaub ntawv ntawm tus asynchronous API thov cov neeg muas zaub rau tag nrho koj cov neeg muas zaub tso cai rau cov neeg muas zaub (i.e. Retail Customer).

Yuav kom txhawb Asynchronous thov, koj daim ntawv thov yuav tau txhawb Post Notifications peb yuav xa koj (raws li ib daim ntawv ceeb toom URL koj muab thaum sau npe).

Piv txwv li Asynchronous thov URL:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}

BulkID = BulkID muab nyob rau hauv Daim Ntawv Thov Kev Pab Cuam retrieved thaum kuaj. (BulkID=ClientID)

HTTP Header = Authorization:Bearer {client access token retrieve thaum sau npe kuaj}

Teb = HTTP status code 2022 (Qhov no yog ib qho asynchronous thov qhov twg teb yuav muab lo rau daim ntawv ceeb toom URL thaum cov ntaub ntawv npaj). Thaum cov ntaub ntawv npaj txhij txog, peb yuav ncej ib daim ntawv ceeb toom rau koj daim ntawv ceeb toom RAU KOJ DAIM NTAWV ceeb toom URI nrog ib payload ntawm URLs koj daim ntawv thov yuav rov qab los mus rau lub packaged ua ntej. Qauv ntawv ceeb toom zoo li hauv qab no

https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}?correlationID={correlationID}

 

Ua tau rau saum URL nrog client Access token kom tau cov ntaub ntawv.

Rau kev siv: tus hierarchical diagram hauv qab no qhia tau hais tias txoj kev sib raug zoo hierarchy rau cov ntaub ntawv ESPI cov ntaub ntawv hais nyob rau hauv qauv PG&E cov ntaub ntawv.

Thaum kawg koj yuav tau qhov tseeb neeg info rau ib lub hauv paus txhua hnub siv lub sij hawm subscription qauv (i.e., los xaiv cov "Ceeb toom kuv raws li cov ntaub ntawv yog npaj (txhua hnub)" checkbox thaum sau npe).

Yuav kom txhawb txhua hnub subscription qauv, koj daim ntawv thov yuav tau txhawb post Notifications peb yuav xa koj (raws li ib daim ntawv ceeb toom URL koj muab thaum sau npe).

Thaum cov ntaub ntawv npaj txhij txog, peb yuav ncej ib daim ntawv ceeb toom rau koj daim ntawv ceeb toom RAU KOJ DAIM NTAWV ceeb toom URI nrog ib payload ntawm URLs koj daim ntawv thov yuav rov qab los mus rau lub packaged ua ntej. Qauv ntawv ceeb toom zoo li hauv qab no:

https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}?correlationID={correlationID}

Ua tau rau saum URL nrog client Access token kom tau cov ntaub ntawv.

Rau kev siv, cov hierarchical diagram hauv qab no qhia tau hais tias txoj kev sib raug zoo hierarchy rau cov ntaub ntawv ESPI cov ntaub ntawv hais nyob rau hauv qauv PG&E cov ntaub ntawv.

Yog hais tias koj tso cai los ntawm cov neeg muas zaub tau txais xws li "Usage Information" thiab/los yog "Billing Information", koj thov tau cov ntaub ntawv no ntawm lub subscription APIs uas cov ntaub ntawv conforms rau lub schema, espiDerived.xsd, muab saum toj no.

Synchronous Ad Hoc Requests (Standard thiab EEF thib peb tog)

Thov keeb kwm cov ntaub ntawv (rau ob interval peb cov ntaub ntawv thiab nqi ntaub ntawv), ib txoj kev yog siv cov synchronous APIs nrog cov inclusion ntawm pib thiab xaus hnub thov parameters hauv Zulu lub sij hawm.

Piv txwv synchronous thov URL:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}?luam tawm-min={startDate}&luam tawm-max={endDate}

luam tawm hnub uas yuav muab thov kom rub cov ntaub ntawv. Hnub yog nyob rau hauv Zulu lub sij hawm ntawm yy-MM-ddTHH:mm:ssZ (IETC RFC 3339 daim ntawv)

luam tawm hnub uas yuav muab thov kom rub cov ntaub ntawv. Hnub yog nyob rau hauv Zulu lub sij hawm ntawm yy-MM-ddTHH:mm:ssZ (IETC RFC 3339 daim ntawv)

lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Rau API thov uas txais luam tawm-max thiab luam tawm-min-date parameters, tus default yog T-1 (hnub thov rho tawm 1 hnub). Rau peb cov kev thov (e.g., .../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/UsageSummary), peb hais kom muab ib chav 30 hnub los yog ntau tshaj kom muaj ib tug nqi uas overlaps nrog lub sij hawm ntawd, txwv tsis pub cov ntaub ntawv yuav rov qab.

Subscription ID = SubscriptionID koj tau txais kawg ntawm lub OAuth tso cai sequence kom tau ib qho kev mus saib token. Tus subscription ID yog ib feem ntawm qhov chaw muab kev pab parameter hauv lub token teb. (SubscriptionID=RetailCustomerID)

UsagePointID = UsagePoint nyob rau hauv cov subscription ID. Koj yuav tau tag nrho cov ntsiab lus rau ib subscription los hu rau hauv qab no API URL thiab supplying tus saib token rau ntawd subscription nyob rau hauv cov kev tso cai header: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint

HTTP Header = Authorization:Bearer {access token rau no Subscription}

Teb = koj yuav tau rov qab cov ntaub ntawv synchronously rau ntawd peb taw tes rau lub sij hawm thov. Nws yuav muaj ob yam interval siv cov ntaub ntawv () thiab nqi ntaub ntawv ().

Synchronous usage APIs (raws li qhia los ntawm lub URL siv uas xaus nrog Usage Point ID) yog ntawm tus neeg Usage Point theem (i.e., Service Agreement level), ces ib daim ntawv thov yuav cycle thov los ntawm txhua lub Usage Point IDs belonging rau ib tug neeg muab kev tso cai (i.e., subscription).

Cov lus teb rau lub synchronous thov rov qab ob cov ntaub ntawv interval (raws li) associated rau hnub ntau yam thov thiab raws li txhua lub hlis peb tag nrho thiab cov nqi uas overlapped nrog thov hnub (raws li).

  • IntervalReading muaj interval (15-min/hourly) fais fab siv thiab interval (txhua hnub) roj siv cov ntaub ntawv
  • Usage Summary muaj cov nyiaj txhua hli thiab nqi kom paub meej (yog tso cai)

Tsis pub dhau cov lus teb koj yuav nrhiav tau cov ntaub ntawv corresponding rau peb ESPI cov ntaub ntawv hais mapping rooj

Rau kev siv, cov hierarchical diagram hauv qab no qhia tau hais tias txoj kev sib raug zoo hierarchy rau cov ntaub ntawv ESPI cov ntaub ntawv hais nyob rau hauv qauv PG&E cov ntaub ntawv.

Cov nram qab no yog ob peb qhov tseem ceeb clarifications rau cov ntaub ntawv hais:

  • Intervalblock yog rau 1 hnub
  • IntervalReading (underneath Interval Block) muaj cov 15-min/hourly fais peb qhov tseem ceeb thiab txhua hnub peb qhov tseem ceeb
  • Rau cov neeg muas zaub hluav taws xob nrog on-site tiam (e.g. Solar), cov flowDirection caij indicates tus tauj (mov) thiab tau txais (tiam) siv cov ntaub ntawv. Rau cov neeg muas zaub nrog meters configured tsuas nyeem cov nuj siv (i.e. tsis muaj tiam on-site), lub flowDirection caij indicates lub caij peb yog ib tug nuj nqi (txawv ntawm tauj minus tau txais):
    • Txaus qhia txog 1 = tauj (zog nkag rau cov neeg muas zaub)
    • Txaus qhia txog 19 = tau txais (nuj tiam ntws rov qab mus rau PG&E grid). (Faj seeb, qhov tseem ceeb yog kiag li)
    • Cov kev taw qhia uas 4 = nuj (tauj rho tawm – tau txais)
  • Them tej xim rau cov hwjchim kaum multiplier thiab unit of Ntsuas (uom) kom peb nyeem ntawv

Batch Subscription (Standard thiab EEF thib peb tog)

Koj kuj thov tau cov ntaub ntawv ntawm lub asynchronous API rau tag nrho cov ntsiab lus Usage belonging rau ib tug neeg muas zaub tso cai rau peb/billing cov ntaub ntawv (i.e. Subscription).

Txhawb lub Ad Hoc Asynchronous thov (i.e., rau ntau tshaj ib zaug xwb Usage point ib lub sij hawm), koj daim ntawv thov yuav tau txhawb post Notifications peb yuav tau xa koj (raws li ib daim ntawv ceeb toom URL koj muab thaum sau npe)

Piv txwv li Asynchronous thov URL
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}?luam tawm-min={startDate}&luam tawm-max={endDate}

Subscription ID = SubscriptionID koj tau txais kawg ntawm lub OAuth sequence kom tau ib qho kev mus saib token. Tus subscription ID yog ib feem ntawm qhov chaw muab kev pab parameter hauv lub token teb

luam tawm hnub uas yuav muab thov kom rub cov ntaub ntawv. (RFC 3339 format zulu time. yy-MM-ddTHH:mm:ssZ)

luam tawm hnub uas yuav muab thov kom rub cov ntaub ntawv. (RFC 3339 format zulu time. yy-MM-ddTHH:mm:ssZ)

HTTP Header = Authorization:Bearer {access token rau no Subscription}

Teb = HTTP status code 2022 (qhov no yog ib tug asynchronous thov qhov twg teb yuav muab lo rau daim ntawv ceeb toom URL thaum cov ntaub ntawv npaj txhij)

Thaum cov ntaub ntawv npaj txhij txog, peb yuav ncej ib daim ntawv ceeb toom rau koj daim ntawv ceeb toom RAU KOJ DAIM NTAWV ceeb toom URI nrog ib payload ntawm URLs koj daim ntawv thov yuav rov qab los mus rau lub packaged ua ntej. Qauv ntawv ceeb toom zoo li hauv qab no:

https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}?correlationID={correlationID}

Ua tau rau saum URL nrog Access token kom tau cov ntaub ntawv. Qhov no yuav muaj ob yam kev sib tham nrog peb cov ntaub ntawv () thiab raws li cov nqi () rau lub sij hawm thov.

Batch Subscription (Standard thiab EEF thib peb tog)
Koj kuj thov tau peb thiab billing cov ntaub ntawv ntawm tus batch bulk asynchronous API rau tag nrho koj cov neeg muas zaub tso cai rau peb/billing cov ntaub ntawv (i.e. Subscriptions).

Piv txwv batch bulk thov URL
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?luam tawm-min={startDate}&luam tawm{endDate}

BulkID = BulkID muab nyob rau hauv Daim Ntawv Thov Kev Pab Cuam retrieved thaum kuaj. (BulkID=ClientID)

luam tawm hnub uas yuav muab thov kom rub cov ntaub ntawv. (RFC 3339 format zulu time. yy-MM-ddTHH:mm:ssZ)

luam tawm hnub uas yuav muab thov kom rub cov ntaub ntawv. (RFC 3339 format zulu time. yy-MM-ddTHH:mm:ssZ)

HTTP Header = Authorization:Bearer {client access token}

Teb = HTTP status code 2022 (qhov no yog ib tug asynchronous thov qhov twg teb yuav muab lo rau daim ntawv ceeb toom URL thaum cov ntaub ntawv npaj txhij)

Thaum cov ntaub ntawv npaj txhij txog, peb yuav ncej ib daim ntawv ceeb toom rau koj daim ntawv ceeb toom RAU KOJ DAIM NTAWV ceeb toom URI nrog ib payload ntawm URLs koj daim ntawv thov yuav rov qab los mus rau lub packaged ua ntej. Qauv ntawv ceeb toom zoo li hauv qab no:

https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?correlationID={correlationID}

Ua tau rau saum URL nrog Access token kom tau cov ntaub ntawv. Qhov no yuav muaj ob yam kev sib tham nrog peb cov ntaub ntawv () thiab raws li cov nqi () rau lub sij hawm thov.

Thaum kawg koj yuav tau qhov tseeb siv thiab billing cov ntaub ntawv xws li corrections rau hnub dhau los tsis pub dhau lub sij hawm tso cai rau ib hnub twg siv lub sij hawm subscription qauv (i.e., los xaiv cov "Qhia kuv raws li cov ntaub ntawv yog npaj (txhua hnub)" checkbox thaum sau npe).

Yuav kom txhawb txhua hnub subscription qauv, koj daim ntawv thov yuav tau txhawb post Notifications peb yuav xa koj (raws li ib daim ntawv ceeb toom URL koj muab thaum sau npe).

Thaum cov ntaub ntawv npaj txhij txog, peb yuav ncej ib daim ntawv ceeb toom rau koj daim ntawv ceeb toom RAU KOJ DAIM NTAWV ceeb toom URI nrog ib payload ntawm URLs koj daim ntawv thov yuav rov qab los mus rau lub packaged ua ntej. Qauv ntawv ceeb toom zoo li hauv qab no:

https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?correlationID={correlationID}

Ua tau rau saum URL nrog Access token kom tau cov ntaub ntawv. Qhov no yuav muaj ob yam kev sib tham nrog peb cov ntaub ntawv () thiab raws li cov nqi () rau lub sij hawm thov.

Tsim tawm cov chaw muab kev pab

Software kev loj hlob kits (SDKs)

 

Pab nrog rau txoj kev loj hlob ntawm software txuas nrog rau feem kuv cov ntaub ntawv platform, nws yuav pab saib cov mechanism koom tes nrog txhua hu rau lub LUAM tawm APIs endpoints. Rau qhov kawg no, PG&E muaj ib co qauv SDKs nws tau tsim yav tag los rau ob JavaScript thiab Python los illustrate tseem ceeb nam ntawm kev cob cog rua cov ntaub ntawv muab kuv cov ntaub ntawv platform. Cov SDKs muab code samples los pab qhia koj los ntawm txoj kev loj hlob ntawm txoj kev loj hlob, tiam sis yuav tsis npaj muab ntau lawm code. Rau JavaScript, koj yuav tau nruab nrab NodeJS, thiab kom "npm install –txuag.." hloov tshiab NodeJS tsev qiv ntawv modules. Qhov chaws no tsis standalone, tiam sis muab snippets uas illustrate li cas cov kev sib tshuam tshwm sim ntawm ib feem peb tog cov ntaub ntawv neeg tau code thiab PG&E feem kuv cov ntaub ntawv API.

 

Pab nrog rau qhov kev siv ntawm cov ntaub ntawv muab kuv cov ntaub ntawv platform, PG&E tsim SDKs hauv ob JavasScript thiab Python. Cov SDKs muab qauv los pab qhia koj txog txoj kev loj hlob ntawm txoj kev loj hlob, tiam sis yuav tsis npaj muab kev ua hauj lwm rau kev ua hauj lwm. 

Download txaus siab APIs (PDF)

Cov ntaub ntawv txaus siab APIs qhia tau hais tias cov APIs txaus siab los ntawm PG&E txoj kev siv feem ntawm kuv cov ntaub ntawv, thiab raws li tus PG&E specific API URL.

 

Download txaus siab ua hauj lwm thaiv tau txoj hlua mapping (PDF)

Cov kev txaus siab los thaiv Scope string Mapping ntaub ntawv captures lus rau txoj hlua uas yog rov qab ua ib feem ntawm cov lus teb rau daim ntawv tso cai Code Thov, tus Access Token Thov, thiab raws li cov kev tso cai API raws li piav nyob rau hauv daim ntawv tso cai Details Overview. Cov parameter pub rau kev sib txuas lus kawg ntawm cov neeg muas zaub tso cai. Tsis tas li, daim ntawv no uas ESPI txheem ua hauj lwm blocks PG&E share kuv cov ntaub ntawv siv.

 

Download txaus siab relational cov ntaub ntawv qauv (PG&E siv ESPI) (PDF)

Nyob rau hauv conjunction nrog cov ntaub ntawv Txaus siab cov ntaub ntawv elements, cov ntaub ntawv Txaus siab Relational Data Qauv illustrates li cas txoj kev sib raug zoo ntawm cov ntaub ntawv PG&E cov ntaub ntawv yog yuav los ntawm cov ESPI txheem.

 

Download txaus siab cov ntaub ntawv hais (PDF)

Cov ntaub ntawv txaus siab cov ntaub ntawv hais txog cov ntaub ntawv muab ib mapping ntawm cov NTAUB NTAWV ESPI txheem cov ntaub ntawv hais thiab PG&E cov ntaub ntawv hais.

PG&E txoj kev siv yog compatible nrog lub ESPI muab schema txhais cov ntsiab lus nyob rau GitHub. Specifically, peb tam sim no siv cov schema versions:

Download XSDs (ZIP)
mus xyuas Github

 

Thov siv raws li qhov kev pab nram qab no kom tiav cov kos npe rau txhua API thov thiab mus kuaj cov API hu rau GBC API Sandbox:

Mus xyuas cov ntsuab Button ntaub ntawv tsev qiv ntawv
mus xyuas cov ntsuab Button API

Muab kuv cov ntaub ntawv siv raws li lub teb chaws zog Service Interface (ESPI) txheem. Tus txheem muaj kuj tau branded li cov ntsuab Button Connect kuv cov ntaub ntawv teg num (GBCMD) raws li nce los ntawm tsev dawb Chief Technology Officer thiab Medal Innovation koj txog haujlwm. Tus ESPI txheem outlines lub framework framework rau delivering functionality nyob ib ncig ntawm cov neeg muas zaub tso cai, cov ntaub ntawv txauv thiab daim ntawv ntawm cov ntaub ntawv tso cai uas yog exchanged. Cov lus no yog them rau cov qauv ESPI thiab GBCMD ntaub ntawv. Nrhiav cov ntaub ntawv ntawm ntsuab Button data.

 

Yuav kom siv tau Kuv Cov Ntaub Ntawv, ob tog yuav tsum xub tau txais thiab muab ib daim ntawv pov thawj X.509 daim ntawv pov thawj los ntawm ib daim ntawv pov thawj trusted rau lawv API sib txuas. Thib peb ob tog yuav ces sau npe nrog PG& E ntawm tus neeg thib peb sau npe, upload lawv daim ntawv pov thawj muaj kuj, tau txais peev xwm ntawm PG&E uas enable lawv mus kuaj lawv qhov zoo sib xws, thiab tom qab tau bearer tokens los ntawm peb cov ntaub ntawv custodian tso cai rau endpoints. Cov bearer tokens yog piav nyob rau hauv cov qauv OAuth2 thiab enable peb tog software kom ruaj ntseg txuas PG&E cov ntaub ntawv mus saib APIs. Tus SDK muab kev sib tshuam txog yuav ua li cas kom tau cov tokens hauv tsab ntawv code.

 

Client access bearer tokens thiab cov neeg muas zaub access bearer tokens yog tau nyias nyias thiab hu ua Client Access Tokens thiab Access Tokens, feem. Access Tokens yog tau txais ib tug neeg PG&E cov neeg muas zaub tso cai. Ib tug raug workflow yog ib tug uas raws li OAuth2, ib tug txheem (IETF 6749) tso cai mechanism, qhov twg ib tug neeg pib ntawm ib feem peb tog chaw, thiab tias qhov chaw redirects cov neeg muas zaub https://sharemydata.pge.com/#MyAuthorization/ thawj rau authentication. Muaj, cov neeg authenticates nrog PG&E thiab mus txog ib scope defining tso cai ntawm lawv cov ntaub ntawv mus saib rau peb tog ("Click-through" txheej txheem). Raws li tiav, PG&E redirects rov qab mus rau tog thib peb nrog ib HTTP 302 teb, whereupon tus neeg thib peb yog npaj tau bearer tokens (saib token). Ntsuam xyuas kom paub meej txog txoj kev (PDF, 463 KB).

 

Tus thib peb tog neeg tau kev pab connects rau PG&E cov ntaub ntawv mus saib API endpoints los ntawm kev sib nrig sib TLS 1.2 sib txuas. Tus neeg API endpoint access controlled los bearer tokens; Thaum thov txais thiab txheej txheem, cov ntaub ntawv yog rov qab rau hauv ib synchronous teb los yog ib lo lus teb asynchronous teb raws li ib daim ntawv ceeb toom rau ib feem peb tog specified URL.

 

Cov ntaub ntawv raws li cov aforemented ESPI schema. Rov muab cov lus piav qhia txog cov ntsiab lus piav txog lub caij nyoog (PDF, 283 KB).

 

PG&E tso cov ntaub ntawv raws li cov tau pub rau peb tog thiab cov neeg muas zaub tso cai.

 

Ntsuam xyuas ib lub ntsiab txhais ntawm covscope (XLSX), thiab kuj ua raws li cov ntsuab Button scope txhais.

 

Ua ntej yuav sau npe siv Kuv Cov Ntaub Ntawv, peb mas pom zoo tias koj thiab koj lub koom haum paub koj tus kheej nrog rau cov chaw muab kev pab nram qab no:

 

Mus ntsib cov ntaub ntawv ntsuab khawm SDK
Cuab yeej rau tsim, kuaj, thiab displaying ntsuab Button cov ntaub ntawv. Nrhiav tus SDKs tsim los ntawm PG&E: JavaScript (ZIP, 1.7 MB) | Python (ZIP, 5 KB)

 

Mus ntsib lub ntsuab Khawm API Sandbox
No API sandbox pub developers daim ntawv qhia txog kev saib, nyob rau hauv ntsuab Button Format, zog usage cov ntaub ntawv rau lub hom phiaj ntawm tsim tshiab ntsuab Button applications.

Vim finite lawv cov chaw muab kev pab thiab raws li tso cai PG&E kom txo cov lag luam uas yuav raug, cov API Harbor txwv yog nyob rau hauv qhov chaw kom mus tsis tu ncua platform stability rau peb cov neeg siv.

  • Ib tug thov ib ob vendor thoob tag nrho cov neeg muag khoom ID tus
  • 2,000 API hu ib teev twg ID
  • 20,000 API hu ib lub sij hawm 24-teev ib tug neeg id ID. Lub sij hawm Harbor txwv resets ntawm 5 p.m. PT

Thov paub hais tias peb yuav tsum siv tej yam mob uas yuav hloov tau. Feem kuv cov ntaub ntawv pab neeg no continually soj ntsuam peb muaj peev xwm txhawb peb tog thov raws li lub platform loj hlob thiab cov neeg siv integrate nrog lawv. Txawm li ntawd los, peb yuav tau sib tham txog tej kev hloov no ua ntej.

Thov saib cov lus qhia nram qab no rau kev txhim kho thiab kev hloov peb twb tau ua los muab kuv cov ntaub ntawv. Yog koj pom ib qhov teeb meem nrog Share Kuv cov ntaub ntawv los yog muaj ib suggestion rau kev txhim kho qhov kev pab cuam, hu rau peb ntawm ShareMyData@pge.com.

Lub Rau Hlis Ntuj 20, 2024

 

PG& E feem kuv cov ntaub ntawv Platform (SMD) rau cov neeg muas zaub-tso cai sib koom nrog peb tog Service Cov Neeg Muab Kev Pab Tso Cai Theem 2 ntawm peb meter ID Txhim Khu kev qha, uas qhia txog tus neeg meter ID associated nrog fais interval meter ntaub ntawv.  

Qhov txhim khu kev qha no tshwj xeeb tshaj yog pab rau cov neeg siv scenarios uas ntau meters yog associated nrog ib daim ntawv pom zoo.

 

Theem 1:  Tso lub peb hlis ntuj 2023 - Modified tej yam APIs pib ntxiv ib tus nqi nrog rau lub tus nqi nyob rau lo lus teb rov qab, raws li tus tag nrho. Nws muaj nws ib one-to-one correspondence ntawm tus nqi serialNumber thiab utcNumber tus nqi.

Cov ntaub ntawv no tso cai rau cov neeg muag khoom siv cov API kom lawv muaj ib lub khw ntawm cov ntaub ntawv nrog rau lub utcNumber nrog rau tus nqi serialNumber tus nqi associated nrog ib meter meter rau lawv cov neeg muas zaub puag ua ntej lub Phase 2 txhim khu kev qha tawm.

 

Theem 2: Tso rau lub rau hli ntuj 20, 2024 - Replaces lub MeterReadingID qhov tseem ceeb ntawm cov tam sim no encode64 daim ntawv ntawm meter descriptive qhov tseem ceeb nrog lub utcNumber. Thaum cov kev hloov no mas DVR, Muab kuv cov ntaub ntawv cov neeg siv yuav muaj ib qho zoo tuaj mus txuas rau meters interval usage, Nyob rau hauv cov neeg uas muaj ntau meters ntawm tib yam txuas rau ib daim ntawv pom zoo rau premise, rau lub meter ID uas generated peb. 

 

Cov APIs yog feem los ntawm cov Theem 2 hloov

Feem API:

.../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading

.../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading/MeterReadingID}

.../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading/MeterReadingID}/IntervalBlock

.../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading/meterReadingID}/IntervalBlock/{IntervalBlockID}

Tag nrho lwm API tus nrog interval nyeem yog unchanged thiab sawv cev rau summ ntawm meter intervals nyob rau hauv ob cov kev taw qhia txaus qhia thiab nrog tag nrho cov meters nyob rau hauv ib daim ntawv cog lus.

Ua ntej qhov uas qhia lub MeterReadingID teb yog Base64 encoded thiab tus nqi rov qab qhia tau hais tias raws li nram no:

MeterReadingID= TnpJNmJuVnNiRG96TmpBd09qRT06MTox

Decoded ntawm Base64 daim ntawv raws li:  NzI6bnVsbDozNjAwOjE=:1:1

Qhov no qhia tau hais tias nyeemTypeID:rownum:suav, thiab nyeemTypeID tus nqi yog decoded ntawm Base64 dua li:

72:null:3600:1 qhov tseem ceeb yog uom:theem:intervalLength:flowDir

UOM=72, theem=null, intervalLength=3600, thiab flowDir=1 (tauj)

Nyob rau theem 2, lub MeterReadingID teb yog appended nrog cov cim ntxiv thiab tom qab mus txog ib pib decoding yuav rov qab cov piv txwv tom qab piv txwv

MeterReadingID=TnpJNmJuVnNiRG96TmpBd09qRT06MToxOjQ0MTEzMTA1NDYGICAgICAgICAg

Decoded ntawm Base64 ib zaug:  NzI6bnVsbDozNjAwOjE=:1:1:4411310546, 

Qhov no qhia tau hais tias meter_UUID yog 4411310546, thiab tus nqi no yuav tsum phim lub tus nqi muaj nyob rau hauv lub RetailCustomer API nyob rau hauv cov tag nrho.

Tus nqi ntawm "NzI6bnVsbDozNjAwOjE=:1:1:1:" Yog tus nyeem ntawv:rownum:suav, i.e. uake yog 1 thiab suav yog 1 hais txog PG&E tus database database ntaub ntawv. Tus nyeem NtawvTypeID yog decoded dua li:

72:null:3600:1, qhov twg qhov tseem ceeb yog uom:theem:intervalLength:flowDir

UOM=72, theem=null, intervalLength=3600, thiab flowDir=1 (tauj)

 

Qhov kev hloov no tso cai rau cov neeg siv los hais lub cev meter thiab txaus qhia txog kev txaus siab rau cov nyeem ntawv interval nyeem. Nco ntsoov tias tag nrho cov ntaub ntawv XML yuav tam sim no muaj lub meterReadingID qhov tseem ceeb thiab yuav tau thov cov theem tshiab 2 daim ntawv ntawm encoding. Muab kuv cov ntaub ntawv tawm tswv yim tag nrho cov neeg muag khoom uas siv tej API hu siv MeterReadingID, ua tus API hu kom tau tus tshiab MeterReadingID: ./espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading

Lub peb hlis ntuj 20, 2023

 

Dab tsi yog tshiab:

 

  1. Tso tawm ntawm ib tug tshiab API HTTP teb chaws (204) rau ob synchronous thiab asynchronous API hu qhia thaum tsis muaj ntaub ntawv yog muaj rau ntau yam.
  2. Txhawb ib x-transaction header daim ntawv lo uas txhawb lub peev xwm txuas PG&E lo lus teb rau specific Asynchronous API hu los rov qab tus nqi no nrog rau ib correlation ID thaum thov cov ntaub ntawv yog npaj txhij.
  3. Zoo tuaj ntxiv cov ntaub ntawv granularity rau lub UsagePoint/MeterReadingID API los muab hluav taws xob interval ntaub ntawv rau ntau meters rau tib service Agreement scenarios.
  4. Muab clarity ntxiv clarity los nyeem qhov tseem ceeb indicator rau KWV YEES li ntawm cov ntaub ntawv los piav seb hom kwv yees siv rau ntawd interval. Qhov tseem ceeb tshiab qhia kwv yees logic muaj tau thov hauv qab no:

  5. RQI tus nqi thiab piav txog

    0 - Valid: cov ntaub ntawv uas tau ncaim ntawm tag nrho cov tshev mis validation thiab xws li kis lawv tag nrho los yog tau raug qhia tseeb

    7 - Manually edited: hloov los yog pom zoo los ntawm ib tug neeg

    8 - kwv yees siv hnub: cov ntaub ntawv tus nqi yog hloov los ntawm ib lub tshuab computed tus nqi raws li tsom xam cov ntaub ntawv keeb kwm siv tib yam kev ntsuas

    9 - kwv yees siv linear interpolation: cov ntaub ntawv tus nqi yog computed siv linear interpolation raws li cov nyeem ntawv ua ntej thiab tom qab nws

    10 - Questionable: cov ntaub ntawv uas muaj tejyam uas muaj ib los yog ntau tshaj cov tshev mis

    11 - Derived: cov ntaub ntawv uas twb tau xam (siv logic los yog mathematical haujlwm), tsis tas ntsuas ncaj qha mus ncaj qha

    12 - projected (huab cua): cov ntaub ntawv uas twb tau xam raws li ib qhov projection los yog huab cua yav tom ntej nyeem ntawv

    13 - Mixed: indicates tias qhov zoo ntawm no nyeem ntawv muaj mixed characteristics

    14 - nyoos: cov ntaub ntawv uas twb tsis ncaim ntawm cov validation, editing thiab kwv yees. NOTE MV90 Meters RQI indicator yuav nyob twj ywm hauv 14 ua ib kawg RQ raws li txoj cai

    15 - Normalized rau huab cua: qhov tseem ceeb muaj tau kho rau tus account rau huab cua, piv rau peb nyob rau hauv kev nyab xeeb sib txawv

    16 - Lwm yam: specifies tias ib cim xeeb uas tsis yog cov txhais

    17 - Validated: cov ntaub ntawv uas twb tau validated thiab tej zaum edited thiab/los yog kwv yees raws li cov txheej txheem pom zoo

    18 - Verified: cov ntaub ntawv uas ua tsis tau tejyam uas tsawg kawg yog ib yam ntawm cov tshev mis validation, tiam sis yog txiav txim tau los sawv cev rau peb

    19 - Revenue zoo: valid thiab txais rau billing purposes [tau extension rau ESPI txheem, thiab tsis ib feem ntawm cov thawj ESPI]

     

  6. Tso cov neeg muag khoom API siv metrics hauv feem kuv cov ntaub ntawv thib peb tog vendor portal.

Kaum ib hlis 15, 2018

 

Dab tsi yog tshiab:

 

  1. Cov neeg muas zaub Indicator muaj tau ntxiv. Txhua TUS HAIS TIAS yog tso cai yuav muab qhia raws li RES, AGR, COM/IND los yog lwm yam.
  2. Billing thiab Usage APIs yuav muab kho tshiab-max thiab tshiab-min query parameters (raws li ib lwm txoj rau luam tawm-min thiab luam tawm-max). Cov ntaub ntawv rov qab yuav tag nrho cov kev hloov uas tau tshwm sim nyob rau hauv cov tshiab-max thiab tshiab-min parameters.
  3. Hloov siv ib feem peb tog 5-digit Bulk ID nrog tus neeg tau id id rau hauv internet tso cai.
  4. Muab qhov kev xaiv rau ib feem peb tog los redirect cov neeg muas zaub los yog PG&E tus account login los yog tus qhua Access tab sis ua ib feem ntawm cov kev tso cai hauv internet txaus.
  5. Kev txhim kho PG&E feem kuv cov ntaub ntawv dashboard kom nws yooj yim rau cov neeg muas zaub saib tag nrho lawv cov ntaub ntawv uas twb muaj lawm sib koom nrog peb ob tog.

Cuaj hlis 27, 2018

 

Dab tsi yog tshiab:

 

PG& E ntxiv cov ntaub ntawv tshiab hais rau txoj cai 24 cov ntaub ntawv teev ua ib feem ntawm PG&E expanded cov ntaub ntawv teev (EDS) peb tes num, thiab corresponding cov ntaub ntawv tshiab yog nkag tau rau hauv txoj cai 25 cov ntaub ntawv teev. Cov ntaub ntawv hais comprising PG&E expanded txoj cai 25 cov ntaub ntawv teev tseg yog teem rau hauv qab no nrog designation EDS:

 

Txoj Cai 25 Cov Ntaub Ntawv Hais Txog Kev

 

ntawv ceeb toom
Cov Ntsiab Lus Hais Txog Kev Txiav Txim
Tus Account Npe
Chaw Nyob Tus
Account Account ID
EDS:
thaiv Cov Kev Pab Cuam
PG& E UUID
ID
Yav tom ntej hloov mus rau Status Service
SA Status
Hnub Pib
Chaw Muab
Kev Pab Tam sim no Service Tariff
Keeb kwm Billed Service Tariff
Tariff Options (Medical Baseline, CARE, FERA, TBS, CCA_TBS, Solar Xaiv
Tam sim no Service Voltage thiab npas keeb kwm Billed Service Voltage
Meter Number
Xov Tooj Ntawm Cov Meters
Meter Type
Tam sim no meter nyeem cycle
Keeb kwm Billed Meter nyeem cycle
Tam sim no Standby tus nqi xaiv yog On-site tiam Indicator
Keeb kwm Billed Standby tus nqi xaiv
EDS: Cov neeg muas zaub indicator
Keeb kwm Billing Elements
Bill pib hnub
Bill xaus hnub
Bill tag nrho tsub ($)
Bill tag nrho kWh
EDS: Lub Npe Ntawm Qhov Chaw Muab
Kev Pab Keeb kwm Bill Tier Breakdown (yog muaj)
EDS: Kab bill Period
EDS: Lub npe (nyob baseline 1%-30%)
EDS: Volume (1234.2)
EDS: Tus nqi ($0.032/kWh)
EDS: Nqi ($100.23)
Keeb kwm Bill TOU kWh breakdown (tsuas yog rau ABS-TX billed)
EDS: Kab Bill Period (rau TOU breakdown)
EDS: Lub npe (TOU charge)
EDS: Volume (1234.2)
EDS: Tus nqi ($0.032/kWh)
EDS: Nqi ($100.23)
Keeb kwm Bill demand Breakdown
EDS: Kab bill Period (rau thov breakdown)
EDS: Lub npe
EDS: Volume (1234.2)
EDS: Tus nqi ($0.032/kWh)
EDS: Nqi ($100.23)
Keeb kwm Bill Kab khoom
EDS: Kab bill Period
EDS: Them lub npe (DWR Bond Charge)
EDS: Volume (1234.2)
EDS: Unit (kWh)
EDS: Tus nqi ($0.032/kWh)
EDS: Nqi ($100.23)
Keeb kwm Usage Intervals
Interval usage pib
Default Interval Duration (hauv vib nas this)
Interval usage Volume (1234.2)
Unit (kWh/Therms)
Chaw Tso Dej Thov Kev Pab Cuam
(DR) Qhov Kev Pab Cuam Lub Npe
Hnub Ua ntej lawm hnub tsis muaj nyiaj txiag obligation
Earliest Termination hnub tsis hais txog nyiaj txiag obligation
DR Program Status
DR Program Hnub Tim
DR Program De-Enrollment Date
Cov Ntsiab Lus Hais Txog Cov Ntsiab Lus

npas Lub sij hawm hauv zos Parameters (DST paub meej)
Default Data Zoo
Kev taw qhia
zog Hwj huam ntawm kaum Multiplier (rau interval peb qhov tseem ceeb)
Hwj huam ntawm kaum Multiplier (rau Billed Demand)
Hwj huam ntawm kaum Multiplier (rau Billed tag nrho peb)
Interval Length(of Usage Reading)
Txiaj nqi tag nrho cov nqi
Hluav Taws Xob Interval TOU Indicators

May 28, 2018

 

Ua ib feem ntawm qhov Click-by peb tes num thiab txuas ntxiv mus txhim kho rau feem kuv cov ntaub ntawv Platform, PG&E launched Click-through Theem 2 rau lub rau hli ntuj 28, 2018.

 

Dab tsi yog tshiab:

 

Qhov tseem ceeb tshaj plaws hloov uas tej yam peb ob tog yog hloov mus conform rau lub OAuth 2.0 protocol (PG&E eliminated pib ntawm redirects). Nrhiav kom paub meej hauv qab no.

 

TSEEM CEEB: Ob tog yuav tsum tau hloov rau lawv cov OAuth implementation. PG& E click-through Theem 2 hloov yuav TSIS backwards compatible, ces nws tseem tsim nyog rau peb ob tog los siv kev hloov concurrent nrog PG&E txoj kev siv. Tsis muaj kev siv, cov neeg muas zaub tam sim no tso cai yuav tsis ua hauj lwm rau lub cut-off hnub ntawm lub rau hli ntuj 29, 2018. Cov kev tso cai uas twb muaj lawm, tsis tas li ntawd, yog unaffected.

  1. Yuav kom paub meej tias cov OAuth 2.0 protocol, PG&E tau txo pes tsawg tus redirect kauj ruam rau kev tso cai. Thawj redirect rau PG&E rau cov neeg muas zaub log thiab xa ib daim ntawv tso cai muaj tau tag nrho nrog rau qhov kev tso cai thov raws li nram no:
    • Raws li muaj nyob rau hauv cov piv txwv hauv qab no, peb tog Authorization code thov tam sim no comprise ib redirect ntawm tus neeg browser rau PG&E tus tshiab authorizationServerAuthorizationEndpoint URI, nrog rau kev thov parameters:
      GET https://sharemydata.pge.com/myAuthorization?client_id=xxxxx&redirect_uri={redirect_uri}&response_type=code&{optionalState}
    • Cov endpoint muaj tau txijnkawm: https://api.pge.com/datacustodian/oauth/v2/authorize...
  2. Tshiab yuam kev tuav lus rau kev tso cai thov uas ploj lawm los yog invalid scope parameters raws li nram no:
    • Yog hais tias cov client_id los yog redirect_uri parameters uas ploj lawm los yog invalid, ib qho (http 400) yuam kev uas explanatory lus yog muaj rau cov neeg muas zaub
    • Yog hais tias tus yuav tsum tau response_type parameter yog uas ploj lawm los yog invalid, cov neeg muas zaub yuav tsum redirected rov qab mus rau tus neeg thib peb redirect_uri nrog ib "invalid_request" yuam kev parameter (appended rau lub redirect_uri)
  3. Rau cov neeg muas zaub uas twb muaj lawm hauv internet, muaj peev xwm thov ib tog tshiab access_token/refresh_token khub ua ib feem ntawm ib daim ntawv tso cai tshiab uas hloov tus uas twb muaj lawm ib (i.e., hauv internet tso cai ntawm tib tog thiab cov neeg muas zaub thaum lawv tseem). No functionality chaw nyob scenarios ntawm ob tog poob ib access_token/refresh_token khub los yog txwv tsis pub hloov qhov uas cov thawj tso cai rau ib tug neeg pom zoo.
    • Rov tso cai thov, cov neeg muas zaub pom cov nplooj ntawv tshiab tsis txhob siv cov "tswj kev tso cai" thaum redirected los ntawm ib feem peb tog rau PG&E rau kev tso cai
    • Raws li cov neeg tso cai, peb ob tog tau txais ib daim ntawv ceeb toom rau lawv sau npe URL tias cov laus subscription ID yog raug muab tso tseg (daim ntawv tso cai API URL endpoint rau cov laus subscription ID)
  4. Muaj peev xwm rau ib tug neeg tawm ntawm ib "cancel" khawm rau xws li cov nplooj ntawv authentication los yog tso cai rau nplooj ntawv nrog redirect rov qab mus rau tus neeg thib peb tog redirect_uri nrog ib "access_denied" yuam kev parameter (appended rau lub redirect_uri)
  5. Rau ob tog uas sau npe nrog cov "visibility" teem rau thiab yog li no muaj nyob rau hauv daim ntawv uas sau npe thib peb ob tog yuav pom thaum lawv mus rau lawv PG&E hauv internet thiab navigate rau feem kuv cov ntaub ntawv yuav tsaws nplooj ntawv:
    • Rau cov neeg muas zaub uas log rau lawv PG& E hauv internet nyiaj thiab navigate rau feem kuv cov ntaub ntawv yuav tsaws nplooj ntawv thiab ces redirected rau peb tog sau npe "Thib peb tog Portal URI" raws li xaiv ib feem peb tog ntawm daim ntawv sau npe thib peb. Nyob ntawd txij, cov neeg muas zaub yuav npaj nrog tus neeg thib peb teg num OAuth txheej txheem. Thaum mus txog txoj kev no, cov neeg muas zaub yuav tsis tau pom tias cov nplooj ntawv tso cai raws li xaiv ib feem peb tog ntawm daim ntawv teev cov dropdown ntawm ob tog, tiam sis xwb yuav redirected rau tus neeg thib peb sau npe "Thib peb tog Portal URI" uas lawv yuav pib tus neeg thib peb teg num OAuth txheej txheem
    • Lus Cim Tseg: Ib txhia ob tog tau nug txog yuav streamline cov neeg muas zaub kev siv rooj plaub no (i.e., tso cai rau PG&E qhov chaw) xws li cov neeg muas zaub nws zoo nkaus li lawv noj ncaj qha mus rau ib nplooj ntawv tso cai raws li xaiv ib feem peb ntawm tus dropdown. Pab txhawb tej tus neeg muas zaub kev, peb ob tog yuav xaiv teev lawv "Thib peb tog Portal URI" (ntawm qhov muab kuv cov ntaub ntawv tswj sau npe) rau ib endpoint uas automatically redirects cov neeg muas zaub rov qab mus PG&E ua ib feem ntawm ib daim ntawv tso cai thov. Raws li automatic redirect rov qab mus PG&E tus authorizationServerAuthorizationEndpoint, cov neeg muas zaub yuav hla cov neeg muas zaub login (raws li lawv twb logged) thiab yuav ncaj qha mus rau cov nplooj ntawv tso cai. Rau ib co thib peb tog uas tau sau npe ua ntej qhov muab kuv cov ntaub ntawv click Thru 2.0 tso tawm, Qhov no yuav tau accomplished los tsuas defining tus thib peb tog Portal URI mus sib npaug zos qhov tsis siv "Thib peb tog Scope Xaiv Screen"URI (laus SMD Registration teb yuav tsum txijnkawm yav tom ntej tso).
      Contrast, ib txhia ob tog yuav xav xwb ua ntej txuam yuaj thiab screen cov neeg muas zaub rau lawv sab thaum cov neeg muas zaub yog redirected rau lawv 'Thib peb tog Portal' URI ua ntej thov ib daim ntawv tso cai code, ces saum toj no yog ib suggestion xwb.
  6. SMD yuav tam sim no muab enhanced Scope parameter paub meej raws li ib feem ntawm cov lus teb rau daim ntawv tso cai Code Thov, tus Access Token Thov, thiab cov Authorization API. Tus enhanced scope parameter pub rau kev sib txuas lus kawg ntawm cov neeg muas zaub tso cai. Particular, cov parameter muaj xws li ib tug "NtxivScope" tus nqi uas maps rau PG&E tus txaus siab rau cov ntaub ntawv xaiv cov ntaub ntawv (e.g. "Usage", "Billing", "Basic", "Account", "Account", "Program"). Qhov tseem ceeb parameter qhov tseem ceeb yog ntxiv tej cov ntaub ntawv nram qab no: Download Txaus siab block Scope string Mapping Click Thru 2.0 (PDF)

    Ib qho piv txwv Token teb hauv qab illustrates ib txhia tau scope parameter qhov tseem ceeb.
    • Piv txwv li Token teb:

      774ff105-7ad5-40c8-a6ec-f60675dc0e41
      3600
      998c654-5b3b-4385-af4f-4e5c46c1b04
      scope=FB=1_3_8_13_14_18_19_31_32_35_37_38_39_40_4_5_10_15_16_46_47; Ntxiv Tau Txais Kev Pab Ntxiv Mus Usage_Billing_Basic_Account_ProgramEnrollment; IntervalDuration=900_3600; BlockDuration=daily; Keeb kwmLength={3P Registered keeb kwm length}; AccountCollection={suav ntawm tso cai SAs};BR={ThirdPartyID}; DataCustodianId=PGE
      resourceURI:{ResourceURI} e.g: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{subscriptionID}
      authorizationURI:{AuthorizationURI} e.g: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{authorizationID}
      CustomerResourceURI:{customerResourceURI} e.g:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
      Bearer


  7. Ob tog yuav tam sim no sau npe rau qhov kev pab cuam sau npe xaiv tsev kawm ntawv ntawm "Program Enrollment" tej pab pawg neeg. Ob interval metered thiab raws li cov neeg muas zaub uas tsis yog-interval metered cov neeg muas zaub yuav tsim nyog tau txais kev tso cai sib koom cov ntaub ntawv rau SMD Click-through Phase 2. Cov ntaub ntawv qib siab (high-level) ntawm cov ntaub ntawv tshiab khiv muaj nyob rau hauv cov ntaub ntawv sau npe xaiv tsev kawm ntawv yog raws li nram qab no:
    • Program (PG& E Thov Teb lub npe/raws li txoj cai thiab CAISO cov lus qhia):
    • (Billing) Chaw Nyob Tus Account
    • Daim Ntawv Pom Zoo Raws Li Txoj Cai
    • (Tam sim no) Service tariff
    • (Tam sim no) Cov kev pab cuam uas tsis yog hluav taws xob (hluav taws xob xwb)
    • Cov meter nab npawb (yog muaj)
    • meter hom
    • (Tam sim no) Meter Nyeem Cycle
    • (Tam sim no) Standby tus nqi xaiv yog On-Site tiam indicator
    • (default interval usage) Duration (ntev hauv vib nas this)
    • (Nkag mus rau PG& Thov teb) Qhov Kev Pab Cuam Lub Npe (yog muaj)
    • Earliest Termination hnub ntawm PG&E nkag teb (DR) Program tsis muaj nyiaj txiag obligation
    • Earliest Termination hnub ntawm PG&E nkag teb (DR) Program tsis hais txog nyiaj txiag obligation
    • PG&E Thov teb (DR) Program (enrollment) Raws li txoj cai
    • PG& E Thov teb (DR) Program Hnub Tim
    • PG& E Thov teb (DR) Program De-Enrollment Date
    • Cov Atom XML XSD (XML Schema Definition) mapping rau cov ntaub ntawv tshiab yog yuav raws li ib daim ntawv teev cov ntaub ntawv nram qab no:
      Download Txaus Siab Cov Ntaub Ntawv Hais Txog Kev Them Nyiaj Yug Me Nyuam (PDF)
    • Associated relational cov ntaub ntawv hierarchy qauv yog outlined ib cov nram qab no:
      Download PGE ESPI Data Model (PDF)
    • UsagePoint (aka SA UUID)
      • ServiceDeliveryPoint\tariffProfile (tam sim no tariff AKA tus nqi teem tseg xws li Standby Tus nqi xaiv yog muaj)
      • nyeem ntawv (tam sim no meter nyeem Cycle)UsageSummary
      • nyeem Ntawv (billing service cycle)
      • Npas (muaj xws li billed voltage theem rau hluav taws xob)
      • tariffProfile (billed service tariff xws li Standby tus nqi xaiv yog muaj
    • Nyeem Ntawv Nyeem Ntawv
      • Npas (muaj xws li voltage theem rau hluav taws xob thiab prefix rau Standby Tus Nqi Xaiv qhov twg)
    • Neeg Muas Zaub Nyiaj
      • (Acct Billing Chaw Nyob):
      • mainAddress/streetDetail...
      • mainAddress/townDetail...
      • mainAddress/postalCode...
    • Cov Neeg Muas Zaub Pom Zoo
      • Raws li txoj cai\tus nqi (SA Status
    • Thov Teb Cov Kev Pab Cuam
      • programname
      • kev sau npe ua hauj lwm
      • programDate/programDate
      • programDate/programDateDescription
    • Lub Twj Ntsuas
      • serialNumber (meter id)
      • hom (meter)
      • (tam sim no) intervalLength
    • Tseeb ESPI xml schema txhais cov ntsiab lus (XSDs) siv rau cov ntaub ntawv tshiab yog outlined ib cov nram qab no:
      Download XSDs (ZIP)
      Faj seeb: Cov XSDs yog backwards compatible.
    • Thib peb ob tog yuav muaj peev xwm hloov lawv sau npe cia cov neeg muas zaub xaiv cov ntaub ntawv no thaum lub sij hawm uas tso cai rau peb tog portal nyob rau hauv tswj >Edit > seem: Qhia cov neeg muas zaub txog koj yuav tsum tau", xaiv qhov Kev Pab Cuam Muaj Npe Xaiv Tsev Kawm Ntawv rau ntawm qhov kev pab cuam.
    • Faj Seeb: Qhov no yuav tsuas siv tau cov kev tso cai tshiab.
    • Tshiab APIs retrieve DR Enrollment information muaj nyob rau ntawm tus bulk 3rd tog theem thiab raws li tus neeg muas zaub tso cai (RetailCustomerID theem), outlined ib cov nram qab no:
      Download tshiab PGE txaus siab APIs (PDF)
    • Asynchronous API thov DR Enrollment information rau tag nrho cov kev tso cai rau ib tog twg thib peb
      • https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailDRPrgInfo/{BulkID}
    • Synchronous API thov DR cov ntaub ntawv rau tus neeg muas zaub tso cai
      • https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailDRPrgInfo/{RetailCustomerID}

 

Thov nco ntsoov hais tias: Dhau li ntawm qhov kev hloov rau cov neeg muas zaub tso cai, lwm yam kev hloov no kuj backwards compatible thiab yog yeem txhim khu peb ob tog yuav xaiv los txhawb.

 

Yog koj muaj lus nug los sis xav tau kev pab ntxiv, xav dawb rau email sharemydata@pge.com.

Dab tsi yog tshiab:

 

  1. Cov neeg muas zaub yuav tam sim no tau kev pab los ntawm cov streamlined Click-By authorization txheej txheem.
    • Peb twb muab kho kom paub meej txog li cas ib tug neeg yuav tam sim no muab cov ntaub ntawv nrog koj lub tuam txhab.
      Kawm li cas cov neeg muas zaub muab cov ntaub ntawv nrog lub tuam txhab

      Faj Seeb:
      Cov kev hloov no, tshwj xeeb tshaj yog txhim kho rau peb cov UI, muaj tau optimized rau mobile li (e.g., tes los yog ntsiav tshuaj).
    • Kev hloov tau ua rau txoj kev tswj cov txheej txheem siv tau rau cov neeg muas zaub los ntawm lawv cov PG&E hauv internet nyiaj:
      • Ib tug neeg muas zaub tseem tshem tawm SAIDs los ntawm ib qho kev tso cai uas twb muaj lawm, cuag hnub tim thiab/los yog muab tso cai rau daim ntawv tso cai thaum twg los tau. Txawm li ntawd los, ntxiv SAIDs thiab/los yog hloov cov ntaub ntawv uas twb muaj lawm yuav tsum tau lawm os thiab ib daim ntawv tso cai tshiab yuav tsum tau tsim.
  2. Yog muaj siab, ob tog yuav tam sim no siv no API rau revoking ib tug neeg tso cai siv lawv tog neeg tau kev pab Mus Saib Token (muab thaum pib SMD thib peb tog registration process) ntawm ib lub lag luam DELETE: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{AuthorizationID}

    Faj seeb 1: Rau PG&E siv, cov AuthorizationID parameter yog tus nqi tib yam li cov SubscriptionID.

    Faj Seeb 2: Tus tshiab API muab ob tog los tshem tawm (cancel) ib daim ntawv tso cai. Txawm li ntawd los, tsuas cov neeg muas zaub lawv tus kheej yuav tshem tau SA IDs thiab/los yog hloov tshiab hnub kawg ntawm peb SMD tswj cov nplooj ntawv.

    Nco ntsoov: Raws li tag nrho cov ntaub ntawv API thov, ob tog yuav tsum xub thov ib tug tshiab Token Khub (Client Access + Refresh Token) siv lawv tseeb Refresh Tokens.

    Nco ntsoov token expiration lub sij hawm:
    • Access Token:1hr
    • Client Access Token: 5 min
    • Corresponding Refresh Tokens: 1Yr
  3. Thib peb ob tog yuav tam sim no tsim ntau share kuv cov ntaub ntawv (SMD) registrations siv tib lub tuam txhab lub npe thiab cov nyiaj ua se tau ID yog hais tias xav tau. Txawm li ntawd los, cov zaub (uas cov neeg muas zaub pom thaum tso cai) tseem yuav tsum tau nws.

    Faj seeb: Tag nrho cov kev hloov saum toj no yog backwards compatible thiab yog yeem txhim khu peb ob tog yuav xaiv los txhawb. Download txhawb cov ntaub ntawv rau qhov kev tso lus muab tawm no:

    SUPPORTED_APIS. SMD_CLICK-THRU_1.0 (PDF)

    SUPPORTED_DATA_ELEMENTS_RETAILCUSTOMER. SMD_CLICK_THRU_1.0 (PDF)

    PGE_ESPI_DATA_MODEL. SMD_CLICK-THRU_1.0 (PDF)

    SUPPORTED_DATA_ELEMENTS_ESPIDERIVED. SMD_CLICK_THRU_1.0 (PDF)

    ESPI_XSDS (ZIP)

Hlis ntuj nqeg 20, 2015

 

Yuav tsum tau hloov: raws li nram qab no: cov nram qab no: cov nram qab no yog cov uas yuav tsum tau hloov ntawm ib feem peb tog.

  1. Xav txog peb ob tog uas muaj GBCMD (Ntsuab Button Connect kuv cov ntaub ntawv) siv ntawm ntau hlauv taws xob besides cia li PG& E, Peb yuav tau kis rov qab cov ntaub ntawvCustodianID (i.e., dataCustodianID=PGE) nyob rau hauv cov redirect rau thirdPartyScopeSelectionScreenURI thaum lub OAuth authorization sequence.
  2. API thov kom txais hnub parameters (e.g., batch request), yuav tsum siv Zulu data parameters (e.g., luam tawm-max/ luam tawm-min). Lwm hom ntawv rau hnub uas parameters hauv API thov yuav tsis txaus siab.
    • APIs uas txais hnub parameters muaj teev tseg ib daim ntawv txuas, txaus siab APIs.xlsx
  3. Interval TOU indicators nrog Interval metered fais fab siv cov ntaub ntawv (raws li muaj, indicator ntawm dab tsi TOU lub sij hawm interval corresponds rau)
    • Thov siv cov static Program ID Mappings detailing dab tsi interval TOU enumeration corresponds rau (e.g., 1 = lub caij ntuj sov Peak etc.). (Saib daim ntawv rhais nrog, Cov ntaub ntawv txaus siab Elements.xlsx)
  4. Cov client_id raws li pom muaj nyob rau hauv cov ntaub ntawvCustodianScopeSelectionScreenURI (siv rau peb tog teg num OAuth) thiab muab nyob rau hauv Daim Ntawv Thov Kev Pab Cuam Thib peb tog thov thaum registration Testing yog muab kho rau 5 digits yog hais tias nws twb tsis (e.g., ntxiv ua xoom xoom thiab). Tsis tas li, cov URL lawm muaj xws li 'verified=true' kawg. Ob tog yuav tau hloov lawv URLs raws li.
    • Elaborate, cov dataCustodianScopeSelectionScreenURI zoo li ua raws li: https://sharemydataqa.pge.com/myAuthorization/?clientId=XXXX (XXXX yog tus neeg tau txais kev pab)
    • Li ntawd, ib tug neeg tau txais kev pab tam sim no ntawm 123 yuav hloov tej yam zoo li 00123 qab hau lawv cov ntaub ntawv tshiabCustodianScopeSelectionScreenURI yuav ua raws li:
      https://sharemydataqa.pge.com/myAuthorization/?clientId=00123 (laus URL tau raws li: https://sharemydataqa.pge.com/myAuthorization/?clientId=00123&verified=true)
  5. Ob tog sau npe ua "ESP" los yog "Zog Qhov Chaw Muab Kev Pab" yog hloov mus rau Standard User Type. Yog tsis muaj kev hloov functionally, tsuas nyob rau hauv cov neeg siv hom npe. Distinguishing ESP neeg siv hom (los ntawm standard User type) yog ib qho un-necessary txawv, yuav ua tsis meej pem thaum lub registration txheej txheem tsis muab tej functionality txawv, li no nws yog txijnkawm.

Txhim Khu Kev Qha: Cov kev hloov no backwards compatible, thiab yog yeem txhim khu peb ob tog yuav xaiv los txhawb.

  1. Thib peb ob tog yuav muaj peev xwm hloov/hloov tshiab lawv SSL certs uas lawv muas thaum chiv thawj muab thaum sau npe (e.g., thaum cert ze expiration) ntawm tus neeg portal hauv tswj >Edit > seem tshiab: SSL Certificate Information (Hloov Tshiab).
  2. Ob tog yuav sau npe tau kev tso cai yooj yim nqi info, cov neeg info, thiab cov ntaub ntawv roj.  Ob interval metered thiab raws li cov neeg muas zaub uas tsis yog-interval metered cov neeg muas zaub yuav tsim nyog tau txais kev tso cai sib koom cov ntaub ntawv rau SMD 2.0. Ib theem ntawm cov ntaub ntawv tshiab khiv muaj cov ntaub ntawv hais yog raws li nram no:
    • Billing Info: (rau ob Interval thiab cov-interval metered SAs)
      • Tus nqi teem tseg, billing $ tag nrho, Tiered siv (raws li muaj), Demand (raws li muaj), TOU tag nrho (raws li muaj)
      •  Lus Cim Tseg: Rau kev tso cai uas tsis yog-interval metered cov neeg muas zaub, ob tog yuav tsuas tau txais nqi tag nrho (i.e., nyob rau hauv Peb Txoj Kev Xaus Lub Neej Sai) thiab tsis muaj interval peb nyeem (e.g., teev/txhua hnub nyeem raws li lawv tsis muaj)
    • Cov neeg muas zaub Info: (rau ob interval thiab cov-interval metered SAs)
      • Tus Neeg Muas Zaub, Qhov Chaw Nyob, Tus Account ID, Daim Ntawv Pom Zoo ID, Daim Ntawv Pom Zoo Muab Kev Pab Hnub Tim,
    • Interval Gas usage cov ntaub ntawv: (interval metered roj SAs xwb)
      • Interval (i.e., txhua hnub) roj nyeem
    • Cov ntaub ntawv tshiab yog diagramed ua ib daim ntawv txuas, Txaus siab cov ntaub ntawv Elements.xlsx
    • Associated relational cov ntaub ntawv hierarchy yog outlined nyob rau hauv cov txuas, PGE ESPI data Model.xlsx
    • Tseeb ESPI xml schema txhais cov ntsiab lus (XSDs) siv rau cov ntaub ntawv tshiab yog ib tug txuas XSDs. Faj seeb: Cov XSDs yog backwards compatible:
      • espiDerived.xsd (Interval Usage thiab Billing Info)
      • retailcustomer.xsd (cov neeg info)

Koj yuav tsum muaj lus nug los yog xav tau kev pab ntxiv, thov hu rau peb ntawm ShareMyData@pge.com.

Hlis ntuj nqeg 18, 2015
 

Yuav tsum tau hloov: raws li cov SMD 2.0 hloov tshiab yuav tsum tau hloov ntawm ib feem ntawm cov neeg siv accessing lawv cov ntaub ntawv:

  1. API thov kom txais hnub parameters (e.g., batch request), yuav tsum siv Zulu data parameters (e.g., luam tawm-max/ luam tawm-min). Lwm hom ntawv rau hnub uas parameters hauv API thov yuav tsis txaus siab.
    • APIs uas txais hnub parameters muaj teev tseg ib daim ntawv txuas, txaus siab APIs.xlsx
  2. Interval Time of Use (TOU) indicators nrog Interval metered fais fab siv (raws li muaj, indicator of TOU lub sij hawm txhua interval corresponds rau)
    • Thov siv cov static Program ID Mappings detailing dab tsi interval TOU enumeration corresponds rau (e.g., 1 = lub caij ntuj sov Peak etc.). (Saib daim ntawv rhais nrog, Cov ntaub ntawv txaus siab Elements.xlsx)

Txhim Khu Kev Qha: Cov kev hloov no backwards compatible, thiab yog yeem txhim khu peb ob tog yuav xaiv los txhawb.

  1. Nws tus kheej access cov neeg siv yuav muaj peev xwm hloov/hloov lawv SSL certs uas lawv muas thaum chiv thawj muab thaum sau npe (e.g., thaum cert ze expiration) ntawm tus neeg portal nyob tswj sau npe > Edit > seem tshiab: SSL Certificate Information (Hloov Tshiab)
  2. Nws tus kheej access registrations yuav muab kho kom muaj kev tso cai yooj yim nqi info, cov neeg muas zaub info, thiab cov nkev cov ntaub ntawv. Ob leeg interval metered thiab raws li cov-interval metered Service Agreements yuav tsim nyog rau (self) kev tso cai rau SMD 2.0 A qib siab uas tshiab khiv muaj cov ntaub ntawv hais txog cov ntsiab lus no raws li nram no:
    • Billing Info: (rau ob Interval thiab cov-interval metered SAs)
      • Tus nqi teem tseg, billing $ tag nrho, Tiered siv (raws li muaj), Demand (raws li muaj), TOU tag nrho (raws li muaj)
      •  Lus Cim Tseg: Rau kev tso cai uas tsis yog-interval metered cov neeg muas zaub, ob tog yuav tsuas tau txais nqi tag nrho (i.e., nyob rau hauv Peb Txoj Kev Xaus Lub Neej Sai) thiab tsis muaj interval peb nyeem (e.g., teev/txhua hnub nyeem raws li lawv tsis muaj)
    • Cov neeg muas zaub Info: (rau ob interval thiab cov-interval metered SAs)
      • Tus Neeg Muas Zaub, Qhov Chaw Nyob, Tus Account ID, Daim Ntawv Pom Zoo ID, Daim Ntawv Pom Zoo Muab Kev Pab Hnub Tim,
    • Interval Gas usage cov ntaub ntawv: (interval metered roj SAs xwb)
      • Interval (i.e., txhua hnub) roj nyeem
    • Cov ntaub ntawv tshiab yog diagramed ua ib daim ntawv txuas, Txaus siab cov ntaub ntawv Elements.xlsx
    • Associated relational cov ntaub ntawv hierarchy yog outlined nyob rau hauv cov txuas, PGE ESPI data Model.xlsx
    • Tseeb ESPI xml schema txhais cov ntsiab lus (XSDs) siv rau cov ntaub ntawv tshiab yog ib tug txuas XSDs. Faj seeb: Cov XSDs yog backwards compatible:
      • espiDerived.xsd (Interval Usage thiab Billing Info)
      • retailcustomer.xsd (cov neeg info)

Koj yuav tsum muaj lus nug los yog xav tau kev pab ntxiv, thov hu rau peb ntawm ShareMyData@pge.com.

Hlis ntuj nqeg 18, 2015
 

Yuav tsum tau hloov: cov nram qab no: cov nram qab no: cov nram qab no yog cov uas yuav tsum tau hloov ntawm CCA siv.

  1. Ad hoc thov (e.g., rau keeb kwm cov ntaub ntawv), yuav tsum tau siv Zulu sij hawm parameters. Lwm hom ntawv rau hnub uas parameters hauv API thov yuav tsis txaus siab.
  2. Lub sij hawm bulk usage noj yuav pib muaj xws li nqi kho mob info thaum lub sij hawm bulk neeg noj yuav muaj xws li cov neeg muas zaub info. Cov ntaub ntawv tshiab no yuav muab ob leeg rau interval metered cov neeg muas zaub uas lawv tau txais cov ntaub ntawv rau tam sim no, thiab raws li cov-interval metered cov neeg muas zaub nyob rau hauv lawv lub chaw uas zoo heev uas lawv tsis tau txais cov ntaub ntawv tam sim no. Thaum kawg, interval peb qhov tseem ceeb muab rau lub sij hawm bulk peb noj yuav muaj xws li interval TOU indicators qhov twg. Qib siab uas cov ntaub ntawv tshiab yog raws li nram no:
    • Billing Info: (rau ob Interval thiab cov-interval metered SAs)
      • Tus nqi teem tseg, billing $ tag nrho, Tiered siv (raws li muaj), Demand (raws li muaj), TOU tag nrho (raws li muaj)
    • (Ntxiv) Cov neeg muas zaub Info: (rau ob interval thiab cov-interval metered SAs)
      • Tus Neeg Muas Zaub Lub Npe, Qhov Kev Pab Cuam, Qhov Kev Pab Daim Ntawv Pom Zoo Pib Hnub Tim, Account ID
    • Interval TOU indicators nrog Interval metered fais fab siv cov ntaub ntawv (raws li muaj, indicator ntawm dab tsi TOU lub sij hawm interval corresponds rau)
      • Thov siv cov static Program ID Mappings detailing dab tsi interval TOU enumeration corresponds rau (e.g., 1 = lub caij ntuj sov Peak etc.). (Saib daim ntawv rhais nrog, Cov ntaub ntawv txaus siab Elements.xlsx)
    • Tseeb ESPI xml schema txhais cov ntsiab lus (XSDs) siv rau cov ntaub ntawv tshiab yog ib tug txuas XSDs. Faj seeb, cov XSDs yog backwards compatible:
      • espiDerived.xsd (Interval Usage thiab Billing Info)
      • retailcustomer.xsd (Customer Info)
    • Cov ntaub ntawv tshiab yog diagramed ua ib daim ntawv txuas, Txaus siab cov ntaub ntawv Elements.xlsx
    • Associated relational cov ntaub ntawv hierarchy yog outlined nyob rau hauv cov txuas, PGE ESPI data Model.xlsx

Txhim Khu Kev Qha: Cov kev hloov no backwards compatible, thiab yog yeem txhim khu peb ob tog yuav xaiv los txhawb.

  1. CCA tus yuav ua tau ib hoc thov rau cov neeg muas zaub thaum: https://api.pge.com/GreenButtonConnect/espi/1_1/Batch/BulkRetailCustomerInfo/{BulkID} (rov qab tseeb snapshot ntawm cov neeg info thaum lub sij hawm thov), ntxiv rau daim ntawv ceeb toom txhua hnub tau txais.
  2. CCA tus yuav muaj peev xwm hloov lawv SSL cert uas lawv muas thaum chiv thawj muab thaum sau npe (e.g., thaum lub cert ze expiration) ntawm tus neeg portal thib peb portal, raws li tswj sau npe > Edit > seem tshiab: SSL Certificate Information (Hloov Tshiab)

Koj yuav tsum muaj lus nug los yog xav tau kev pab ntxiv, thov hu rau peb ntawm ShareMyData@pge.com.

Lub yim hli ntuj 21, 2015
 

Dab tsi yog tshiab:

  1. Lub xeev param thiab qhov chaw muab kev pab URI hloov hauv Oauth teb
    • Ua ib feem ntawm cov OAuth tso cai code thov, tus neeg thib peb muaj qhov kev xaiv xa nyob rau hauv ib lub xeev parameter uas PG&E yuav xa rov qab mus rau tog thib peb. PG& E yuav xa daim ntawv tso cai rau kev tso cai ua tiav. Qhov kev xaiv no param yuav siv tau los pab tus neeg thib peb qhia qhov twg thov yog tshwm sim, thiab khi cov kev thov rov qab mus rau cov kev tso cai uas lawv pib.
    • Ua ib feem ntawm qhov zoo tiav token thov, peb muab rov qab resourceURI thiab tso cai rau nyias los ntawm cov ntaub ntawv token. Tam sim no cov URIs yog flipped thiab ua ib feem ntawm qhov uas peb yuav tau kho ntawd.

Tsau defects:

  1. Default hnub luam tawm-max thiab luam tawm-min
    Tam sim no PG& E mandates tus neeg xa hauv luam tawm-min thiab luam tawm-max parameters hauv epoch vib nas this rau txhua cov ntaub ntawv thov qhia PG&E lub sij hawm uas lawv yuav thov cov ntaub ntawv. Peb yuav siv hloov kev hloov mus kov thov rau cov scenarios tom qab scenarios:
    • Luam tawm-min thiab luam tawm-max qhov tseem ceeb yog uas ploj lawm
    • Luam tawm-min thiab luam tawm-max qhov tseem ceeb yog nyob rau hauv UTC
    • Luam tawm-min thiab luam tawm-max qhov tseem ceeb yog nyob rau hauv epoch vib nas theem
    Nyob rau hauv cov kev tshwm sim uas cov parameters yog uas ploj lawm, PG&E yuav rov qab default hnub, raws li opposed rau yuam kev li rov qab ua ntej qhov kev hloov no. Default, nyob rau hauv peb rooj plaub, yog ib hnub cov ntaub ntawv rau hnub T-2. Yog hais tias cov parameters muaj tam sim no thiab formatted kom yog peb yuav tsim cov parameters.
  2. Kho rau hnub nyob rau hauv kev tso cai xml
    Tam sim no nyob rau hauv cov kev tso cai xml peb muab cov hnub luam tawm hnub thiab tso cai hnub. Cov hnub no yog nyob rau hauv milliseconds li opposed rau vib nas this uas yog tus txheem. Peb yeej kho nws yuav muab xa rov qab rau epoch vib nas ej tsis txhob milliseconds.
  3. Incorrect XML rov qab mus /resource/Subscription/{id}/UsagePoint/{id}/MeterReading/{id}/IntervalBlock
    Tam sim no peb yuav rov qab tsis muaj tseeb teb rau qhov chaw muab kev pab saum toj no tau qhov twg tus qauv ntawm cov XML yog tsis muaj tseeb thiab peb yuav rov nkag mus rau txhua interval xwb tsis txhob tsim ib zaug xwb interval thaiv rau ib 24 teev duration.

    Qhov no yog tsau thiab tsuas ib zaug xwb interval thaiv yuav rov qab mus rau ib 24 interval thaiv.

Lus nug los yog kev txhawj xeeb? Thov hu rau ShareMyData@pge.com.

Feem ntau cov lus nug

  • Tej qualifying thib peb tog xav saib cov neeg muas zaub-tso cai yuav siv share kuv cov ntaub ntawv.
  • Cov neeg muas zaub nrog cov kev paub siv RESTful APIs (Application Program Interface) mus saib tau lawv cov ntaub ntawv yuav siv tau cov cuab yeej thiab.
  • Yog hais tias koj yog ib feem peb tog thov teb tus neeg zov me nyuam (DRP) koom hauv PG&E txoj cai 24 kom muaj ib qho kev pab thov teb thiab xav siv kuv cov ntaub ntawv, thov mus saib hauv DRP webpage kom paub meej ntxiv.

  • Tej qualifying thib peb tog xav saib cov neeg muas zaub-tso cai yuav siv share kuv cov ntaub ntawv.
  • Cov neeg muas zaub nrog cov kev paub siv RESTful APIs (Application Program Interface) mus saib tau lawv cov ntaub ntawv yuav siv tau cov cuab yeej thiab.
  • Yog hais tias koj yog ib feem peb tog thov teb tus neeg zov me nyuam (DRP) koom hauv PG&E txoj cai 24 kom muaj ib qho kev pab thov teb thiab xav siv kuv cov ntaub ntawv, thov mus saib hauv DRP webpage kom paub meej ntxiv.

  • Ua kom paub meej zog peb cov ntaub ntawv muaj nyob rau hauv ib daim ntawv standardized txhawb khiav ntawm lub zog siv zog thiab raws li innovation ntawm ob tog tshiab-teem daim ntawv thov. Vam cia yog tias zog app developers yuav xav txog tej yam thiab tsim innovative, inspiring txoj kev tshiab rau cov neeg muas zaub los txheeb, tswj thiab thaum kawg txo lawv lub zog siv zog. Cov tshuaj no yog cov kauj ruam tom ntej nyob rau hauv ib lub teb chaws dag zog muab standardized, yooj yim mus saib tau cov ntaub ntawv zog uas yuav unlock cov tiam tom ntej ntawm kev txuag solutions. Muab kuv cov ntaub ntawv muab cov ntaub ntawv raws li qhov zog Qhov Chaw Muab Kev Pab Interface (ESPI) txheem.
  • PG& E lub hom phiaj yog ua tso cai, recurring, tshuab-rau-tshuab, programmatic cov ntaub ntawv muaj rau cov neeg muas zaub thiab lawv tso cai rau peb tog chaw muab kev pab.

  • Kev txuag zog pab ua rau lub zog grid hauv California txhim khu kev qha.
  • Conserving kuj pab peb cov neeg muas zaub vim siv zog yuav txuag tau lawv cov nyiaj.
  • PG& E tsis ua profits ntau dua los muag ntau zog, uas ua PG&E thiab lwm investor-muaj hlauv taws xob hauv California distinctly txawv ntawm cov tuam txhab uas muag uas ua profits los muag ntau tshaj ntawm ib tug muab npas. Ib txoj kev PG& E ua nyiaj yog los ntawm incentives khwv tau los ntawm achieving zog efficiency hom phiaj teev los ntawm peb regulator, California Public Utilities Commission.
  • Thaum peb cov neeg muas zaub conserve zog nws tseem zoo rau lawv thiab nws tseem zoo rau peb ua hauj lwm.

Kawm ntxiv txog PG&E hluav taws xob nqi

  • Yog tsis muaj nqi siv kuv cov ntaub ntawv.

  • Los ntawm cov ntsuab Button Download kuv cov ntaub ntawv cuab yeej, cov neeg muas zaub yuav download lawv cov ntaub ntawv siv thiab, yog hais tias lawv xaiv, xa cov ntaub ntawv rau tej tog thib peb lawv xaiv.
  • Qhov no yuav nyob twj ywm rau.

  • Cov neeg muas zaub yuav tsum tso cai rau qhov uas lawv cov ntaub ntawv rau ib feem peb tog siv share kuv cov ntaub ntawv los yog download lawv cov ntaub ntawv ntawm Ntsuab Button Download kuv cov ntaub ntawv rau lawv tus kheej computers thiab ces xa cov ntaub ntawv rau peb tog chaw muab kev pab.

  • Tau kawg. Mus saib hauv webpage, hauv qab no, saib ib daim ntawv teev cov hlauv taws xob uas siv cov kev pab zoo sib xws.

Mus xyuas greenbuttondata.org

  • Rau qhov no, tus CPUC yog qhov kawg governing cai rau leej twg tsis tsim nyog tau txais cov ntaub ntawv tso cai. 
  • Tus CPUC xyuas ntaub ntawv qhia txog misuse ntawm cov ntaub ntawv thiab ua rau kev txiav txim zaum kawg raws li seb cov nqe lus ntawm lub Tariff thiab/los yog cov neeg muas zaub Cov Ntaub Ntawv Privacy thiab kev tiv thaiv cov cai tau raug yuam.
  • Tus Commission muaj cai txiav txim kom muaj hlauv taws xob tam sim ntawd revoke access thiab terminate registration ntawm tuam txhab uas muag los yog cov neeg uas muaj kev yuam cai thiab bar lawv los ntawm kev koom tes yav tom ntej. Yog xav paub ntxiv, xaiv qhov txuas hauv qab no:
    Hluav taws xob txoj cai No.27 (PDF, 1.6 MB)

Thov rov muab los ntsuam xyuas dua thiab sau cov lus hauv qab no ua ntej sau npe nrog Qhia Kuv Cov Ntaub Ntawv.

Mus xyuas tau pib nrog share kuv cov ntaub ntawv
mus sau npe, mus ntsib kuv cov ntaub ntawv

  • Peb khiav lag luam thiab tuav cov ntaub ntawv platform los facilitate lub npe ntawm tuam txhab uas muag uas xav koom rau hauv qhov kev pab cuam Share Kuv cov ntaub ntawv.
  • Peb screen piv txwv kom paub tseeb tias lawv yog tseeb lag luam entities nyob zoo sawv nrog lub CPUC, uas lawv pom zoo kom abide los ntawm cov nqe lus thiab cov neeg muas zaub access Tariff thiab tias lawv muaj lub peev xwm siv cov ntaub ntawv muab kuv cov ntaub ntawv platform.
  • Peb xav kom cov neeg muas zaub soj ntsuam li cas lub tuam txhab uas muag uas lawv xaiv ua lag ua luam nrog yuav tswj thiab tiv thaiv lawv cov ntaub ntawv.

  • PG& E yuav txhawb ib lub npe thiab se ID rau ntau yam registrations. Qhov no txhais tau tias ib zaug xwb yuav muaj ntau registrations nrog cov npe txawv.
  • Koj yuav tau tsim kom muaj cov neeg muas zaub kom tso cai rau lub tuam txhab thiab/los sis lub npe tso rau hauv koj daim ntawv tso cai.

  • Koj cov nyiaj ua se tau id ID yuav tsum muab california Investor Owned Utilities (Pacific Gas and Electric, Yav qab teb California Edison thiab San Diego Roj & Hluav Taws Xob Commission (CPUC) nrog rau ib hom, nws qhia rau koj.

  • Thaum koj tau txais ib tug email qhia koj daim ntawv sau npe tau txais, koj yuav tau log rau koj feem ntawm koj cov ntaub ntawv nyiaj los retrieve koj tus neeg tau txais kev pab peev xwm. Xaiv Cov Kev Pab Thiab koj thiab yuav muab tso tawm rau hauv daim ntawv sau npe Milestone rooj raws li txoj cai.>

Login muab kuv cov ntaub ntawv

  • Thaum koj tau txais ib tug email qhia koj daim ntawv sau npe lawm, koj muaj 90 hnub kom tiav.
  • Yog koj tsis tau sau npe thov kev tshuaj ntsuam tsis pub dhau 90 hnub, koj daim ntawv sau npe yuav tshwm sim thiab koj yuav tau rov qab mus kuaj dua.

Muaj, daim ntawv sau npe yuav expire. Thaum koj sau npe rau txoj kev kuaj no, koj yuav tsum tau kuaj thiab tshawb kom paub tseeb tias koj lub koom haum muaj peev xwm mus cuag PG&E lub nruab li ntawm 90 hnub. Yog hais tias koj muaj ntse tiav qhov kev kuaj ntawd thiab ua ib feem peb tog rau lub Share My Data platform, koj daim ntawv sau npe yuav tsis expire.

  • Peb tsis tau reset passwords yog hais tias koj tsis paub cov lus teb rau koj lo lus nug ruaj ntseg.

  • Peb tsis tau reset passwords yog hais tias koj tsis paub cov lus teb rau koj lo lus nug ruaj ntseg.

  • Koj yuav nkag tau rau hauv koj tus account txhua lub sij hawm los hloov koj profile ntaub ntawv los ntawm kev xaiv Tswj Registration.

Login muab kuv cov ntaub ntawv

  • Thaum koj tau txais ib tug email qhia koj daim ntawv sau npe tau txais, koj yuav tau log rau koj tus account los retrieve koj . Xaiv "Tswj Registration" thiab koj yuav muab tso tawm rau hauv daim ntawv sau npe Milestone rooj raws li txoj cai.

  • Yog hais tias koj tsis xav mus saib tau cov neeg muas zaub-tso cai rau cov ntaub ntawv muab kuv cov ntaub ntawv platform, thov email peb ntawm ShareMyData@pge.com kom muaj koj daim ntawv tso cai. Thov pub txog ob hnub ua hauj lwm rau kev txiav txim kom tiav.

  • Cov neeg muas zaub tso cai rau koj mus saib tau lawv cov ntaub ntawv ntawm kuv lub zog, lawv PG&E hauv internet nyiaj. Rau ib tug xav paub meej overview ntawm li cas cov neeg muas zaub yuav tso cai rau ob tog los yog lwm cov chaw mus saib lawv cov ntaub ntawv, thov saib cov share kuv cov ntaub ntawv thib peb tog Overview.

Mus tso cai kom paub meej tias

  • Tam sim no, tsis muaj txwv.

  • Cov neeg muas zaub xaiv tau ib lub sij hawm uas koj yuav saib tau lawv cov ntaub ntawv, los yog lawv yuav tawm hauv lub sij hawm qhib.
  • Koj daim ntawv thov yuav xyuas tau hnub kawg ntawm ib tug neeg muab kev tso cai los ntawm lwm cov lus tso cai los ntawm hu rau qhov chaw muab kev pab APIs (e.g., .../espi/1_1/resource/Authorization and/or.espi/1_1/resource/Authorization/AuthorizationID}).
  • Xwb, koj yuav manually kos hnub xaus rau logging rau koj tus account thiab xaiv Tswj Authorizations.

  • Yog hais tias ib tug neeg muas zaub xaiv ib lub sij hawm uas tso cai, ces lawv tso cai rau thaum xaus rau lub sij hawm ntawd. Yog hais tias lawv tso cai rau daim ntawv tso cai, ces lawv tso cai expires hnub tom qab lawv tso cai rau daim ntawv tso cai.
  • Yog hais tias ib tug neeg xaiv Indefinite raws li lawv lub sij hawm tso cai, ces lawv tso cai tsis expire. Faj seeb, xav txog txoj cai 24 Thov Teb Cov Neeg Zov Me Nyuam thiab lwm cov kev pab cuam uas siv Qhia Kuv Cov Ntaub Ntawv, tom qab-tus-fact corrections rau yav tas los tso cai rau ob tog mus txog peb xyoos tom qab tso cai expiration.
  • Saib "Li cas yuav cov ntaub ntawv corrections yuav tsum kov?" Xav paub meej ntxiv txog tau txais corrections.

  • Ib pg& E cov neeg muas zaub uas muaj ib qho kev pab tam sim no ID rau roj los yog hluav taws xob yuav tso cai rau koj mus saib tau lawv cov ntaub ntawv siv cov ntaub ntawv tshiab Qhia Kuv cov ntaub ntawv.

  • Cov neeg muas zaub xav koom tes nrog lawv cov ntaub ntawv ntawm qhov kev pab cuam Share Kuv cov ntaub ntawv yog thov nej tsam ces thov nej tsam ces sau npe rau ib tug account kuv zog. Qhov no yuav ua rau tag nrho txoj kev npaum li cas thiab kuj muab lawv lub peev xwm tswj lawv cov kev tso cai hauv internet.
  • Cov neeg muas zaub yuav kos npe rau ib tug account kuv zog thaum uas tso cai rau txoj kev tso cai.
  • Nws muaj nws ib tug txheej txheem manual muaj rau cov neeg muas zaub kom tau ib feem ntawm kuv cov ntaub ntawv tso cai hauv internet thiab xa daim ntawv tiav ntawm email.
  • Yog xav paub ntxiv txog txoj kev manual, thov hu rau peb ntawm ShareMyData@pge.com.

  • Cov neeg muas zaub yuav tsum tau ua lawv cov kev tso cai hauv internet los ntawm lawv pg&E hauv internet. Tiam sis, yog hais tias lawv ua tiav thiab kos npe rau daim ntawv qhia txog kuv cov ntaub ntawv tso cai, ces koj yuav xa nws mus rau PG&E rau lawv behalf.

Download Share My Data Customer Authorization or Revocation of Authorization form (PDF, 308 KB)

  • Koj yuav hloov koj OAuth URIs los logging rau hauv koj tus account, navigating los tswj Registration > Edit > thiab updating teb nyob rau hauv lub OAuth 2.0 Information seem.

  • Koj yuav hloov tau koj daim ntawv ceeb toom TSHIAB los ntawm logging rau hauv koj tus account, navigating los tswj Registration > Edit > thiab updating lub teb nyob rau hauv cov ntaub ntawv access Information Section.

  • Koj yuav hloov koj daim ntawv pov thawj SSL los ntawm logging rau hauv koj tus account, navigating los tswj Registration > Edit > thiab xaiv "Hloov tshiab" nyob rau hauv daim ntawv pov thawj SSL Certificate Information seem. Nco ntsoov tias rau daim ntawv pov thawj tshiab uploads, nws yuav siv sij hawm ntau hnub hloov PG&E lub nruab nrog daim ntawv pov thawj tshiab.  
  • Ib tug paub tseeb email los ntawm cov ntaub ntawv qhia txog kuv cov ntaub ntawv txhawb pab neeg no yuav muab xa thaum daim ntawv pov thawj tshiab muaj tau thov.

  • Thaum koj tau txais ib tug email qhia koj daim ntawv sau npe tau txais, koj yuav tau log rau koj feem ntawm kuv cov ntaub ntawv nyiaj thiab download peb SSL Certificate ntawm lub Download PG&E SSL Certificate nplooj ntawv.

Login muab kuv cov ntaub ntawv

  • Muab kuv cov ntaub ntawv raws li cov ntsuab Button Connect kuv cov ntaub ntawv siv agreements. Muab kuv cov ntaub ntawv kuj ua hauj lwm OAuth 2.0 rau kev tso cai, thauj Layer Security (TLS) 1.2 thiab qhov tsawg kawg suite ntawm kev sib tham isthawmnev hais ruaj ntseg protocols pom zoo los ntawm NIST (Lub koom haum national institute of Standards thiab Technology) xws li cov ntaub ntawv yog exchanged nyob rau hauv qhov tseeb.

  • Tiv thaiv cov neeg muas zaub yog ib feem tseem ceeb rau PG& E. PG& E kho cov ntaub ntawv hais txog lawv cov neeg muas zaub—xws li cov lus qhia txog koj tus kheej—raws li tsis pub leej twg paub, xws li tag nrho cov kev cai thiab ntxawg ntxawg, nrog rau cov neeg tsim los ntawm California Public Utilities Commission thiab lwm cov neeg.  
  • Rau ntau tshaj ob xyoo lawm, PG&E thiab lwm investor-muaj hlauv taws xob hauv California muaj tau kawm nruj CPUC cov kev cai uas txwv lawv los ntawm cov neeg muas zaub-specific ntaub ntawv, xws li billing cov ntaub ntawv, rau ob tog tsis muaj tus qhia txog cov neeg muas zaub.  
  • Thaum ib tug neeg tso cai tso cai rau cov ntaub ntawv, nws yog tus neeg muas zaub thiab peb tog lub luag hauj lwm los tiv thaiv cov ntaub ntawv.
  • Ib tug neeg yuav xaiv kom txhob sib koom cov ntaub ntawv nrog ib feem peb tog twg los ntawm logging rau lawv PG& E hauv internet nyiaj thiab cancelling lawv tso cai. PG& E txoj cai thiab daim ntawv ceeb toom txog accessing, Collecting, Storing, siv thiab qhia zog usage cov ntaub ntawv muaj nyob rau ntawm pge.com/privacy.

  • Tsis pub dhau qhov uas qhia kuv cov ntaub ntawv qhov kev pab cuam, thib peb ob tog yuav muaj kev cuam tshuam rau cov neeg muas zaub Privacy thiab kev tiv thaiv txoj cai specified nyob rau hauv cov ntaub ntawv muab kuv cov ntaub ntawv platform thiab tej yam kev mob thiab cov kev mob uas yuav tsum tau muaj nyob rau hauv cov ntaub ntawv Customer Access Tariff.
  • Thib peb tog no kuj yuav raug rau tag nrho lwm cov kev cai thiab cov kev cai hais txog qhov kev tiv thaiv ntawm cov neeg muas zaub tsis pub twg paub, Xws li, tiam sis tsis txwv rau, cov cai hais txog Privacy thiab ruaj ntseg tiv thaiv rau zog usage cov ntaub ntawv tau txais los ntawm cov CPUC li Attachment D txiav txim siab 11-07-056 (Electric), kuj summarized hauv PG&E txoj cai hluav taws xob tsis muaj 27, thiab California Civil Code Section 1798.80 – 1798.84.
  • Yog xav paub ntxiv, thov xaiv qhov txuas mus, hauv qab no:
    Muab kuv cov ntaub ntawv thiab tej yam kev mob (PDF, 190 KB)
    Electric Rule No. 27 (PDF, 1.6 MB)

    Attachment D rau kev txiav txim siab 11-07-056 (PDF)
    Xav paub ntau ntxiv: California Civil Code Section 1798.80 – 1798.84

  • Thov saib qhov txuas, hauv qab no, kom muaj ib daim ntawv teev cov ntsiab lus uas txaus siab.

Yog xav paub ntau ntxiv txog cov ntaub ntawv access

  • Nyob rau lub ntees, interval peb cov ntaub ntawv yog uas ploj lawm vim peb upstream cov ntaub ntawv validation txheej txheem nrhiav muaj cov uas ploj lawm los yog tsis muaj ntaub ntawv nyeem uas tej zaum yuav tsum tau ntxiv txheej txheem (editing thiab los yog kwv yees).
  • Rau interval billed cov neeg muas zaub (e.g., cov neeg muas zaub nrog time-of-Use billing considerations), cov instances no yog kho nyob rau lub sij hawm kom paub tseeb tias nqi calculation rau lawv yavtom ntej yavtom ntej.

  • Yog hais tias koj xav tau cov ntaub ntawv corrections, thov xyuas kom koj xyuas cov ntaub ntawv qhia rau kuv li Data yog npaj checkbox thaum sau npe los yog logging rau koj tus account hauv internet thiab xaiv no checkbox hauv Edit Profile. Peb yuav ces muaj cov ntaub ntawv corrections uas tau raug yuav los ntawm peb lub cev thaum lub 24 teev dhau los, ua ib feem ntawm lub sij hawm peb noj, rau tej ntaub ntawv uas koj tau tso cai mus saib tau.
  • Cov ntaub ntawv kho mob yuav them rau lub sij hawm uas tso cai rau lub sij hawm uas tso cai, txog li peb xyoos.

lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Xav txog Txoj Cai 24 Thov Teb Cov Neeg Zov Me Nyuam thiab lwm cov kev pab cuam uas siv Qhia Kuv Cov Ntaub Ntawv, tom qab-tus-fact corrections rau yav tas los tso cai rau ob tog mus txog 3rd ob tog mus txog peb xyoos tom qab tso cai expiration.

  • Yog muaj, PG& E yuav xa ntawv ceeb toom tuaj rau koj daim ntawv ceeb toom URL muab rau thaum sau npe. Notifications comprise URLs corresponding twb ua ntej packaged cov ntaub ntawv npaj rau koj rov qab los thiab thov ntawm tus muab URLs. Cov ntaub ntawv yog prepackaged thiab ntawv ceeb toom xa mus rau hauv cov nram qab no ob scenarios: (1) koj twb xaiv "Qhia rau kuv raws li cov ntaub ntawv yog npaj" nyob rau hauv koj daim ntawv sau npe profile, uas peb mam pob qhov tseeb txhua hnub nrog tej corrections rau hnub dhau los, los yog (2) koj twb ua ib tug ua ntej lawm hoc asynchronous thov kom cov ntaub ntawv thov yog tam sim no npaj txhij. Scenario 1 yog illustrated nyob rau hauv cov "DATA ACCESS: NIAJ HNUB SUBSCRIPTION" seem ntawm cov ntaub ntawv Access Methods diagrams rau cov ntaub ntawv Access Page thiab scenario 2 yog illustrated nyob rau hauv cov "DATA ACCESS: AD HOC REQUEST (ASYNCHRONOUS)" seem ntawm tib diagrams kuj nyob rau cov ntaub ntawv access Page.

Mus saib tau cov ntaub ntawv saum toj no

  • Cov ntaub ntawv hluav taws xob muab los ntawm Share kuv cov ntaub ntawv no tsis haum meter Data (SQMD) raws li tau teev tseg los ntawm California Independent System Operator (CAISO). SQMD yog generated los multiplying Revenue Zoo Meter Data (RQMD) los ntawm cov Distribution Poob Factor (DLF) muaj feem xyuam rau cov neeg voltage theem rau ntawd interval, converting lub metered intervals rau lub sij hawm interval yuav tsum tau los ntawm lub CAISO thiab ces summing qhov txheeb xyuas tau rau txhua interval rau cov aggregate theem yuav tsum tau los ntawm caisO.
  • PG& E yog siv flags ntawm tus "QualityOfReading" (QOR) Hom muab los ntawm tus ESPI txheem los sib txuas lus seb cov ntaub ntawv yog Revenue Zoo. Tus QOR Type captures txawv tau qhov tseem ceeb rau peb cov ntaub ntawv, xws li ib tug nqi explicit rau "Revenue Zoo Meter Data" los yog "RQMD." PG& E yuav siv no QOR hom nyob rau hauv nws cov ntaub ntawv transmittal raws li nram no:
    • PG& E txhawb cov ESPI muab "UsageSummary" hoob kawm, uas yuav siv los xyuas cov hnub uas ib daim ntawv pom zoo yog billed, tus nqi siv, thiab cov ntaub ntawv zoo thaum lub sij hawm thov. Lub UsageSummary yuav tau populated thaum tus nqi yog muaj rau cov ntaub ntawv thov thiab yuav muaj ob flags (hais) ntawm QOR Type:
      • Lub UsageSummary.QualityOfReading caij (ntawm lub UsageSummary theem) qhia qhov zoo thaum lub sij hawm thov tseeb muab interval peb qhov tseem ceeb plus corrections corresponding rau lub UsageSummary.billingPeriod hnub.
      • Lub DefaultQuality caij rau OverallConsumptionLastPeriod (ua ib feem ntawm UsageSummary.OverallConsumptionLastPeriod.ReadingTypeRef) qhia qhov zoo tshaj plaws ntawm tag nrho cov nqi tag nrho.
    • PG& E yuav tau sib txuas lus zoo ntawm peb cov ntaub ntawv ntawm lub interval theem thaum lub sij hawm thov siv cov IntervalReading.Nyeem NtawvQuality.Zoo.

  • Thaum sau npe koj yuav xaiv ntau npaum li cas keeb kwm koj xav tau, xws li 24, 36, los yog 48 lub hlis nyob rau hauv cov ntaub ntawv "ntau npaum li cas keeb kwm yog thov" dropdown.
  • Ua ib feem ntawm ib tug neeg muas zaub kev tso cai uas koj mus saib tau lawv cov ntaub ntawv, lub sij hawm keeb kwm rau kev tso cai yuav raug defaulted rau koj daim ntawv xaiv tsa IDs (peb cov ntsiab lus) nyob rau hauv daim ntawv tso cai.
  • Koj yuav hloov koj cov ntaub ntawv keeb kwm, los ntawm logging rau koj tus account, navigating tswj Registration > Edit > thiab xaiv los ntawm cov dropdown labeled "Ntau npaum li cas keeb kwm cov ntaub ntawv yog thov."
  • Thov nco ntsoov tias cov ntaub ntawv uas muaj nyob rau hauv keeb kwm yuav pib nrog hnub uas cov neeg muas zaub ua daim ntawv tso cai, raws li opposed to hnub uas koj ua daim ntawv thov kom lub API.

lub cim kev ceeb toom qhia paub uas tseem ceebFaj Seeb: Kev hloov rau koj cov ntaub ntawv keeb kwm tsuas muaj feem xyuam rau cov neeg muas zaub tshiab, thaum yav dhau los cov neeg muas zaub yuav muaj kev cuam tshuam koj xaiv thaum lub sij hawm uas tau kev tso cai.

  • Raws li ib tug qauv ESPI, cov lus teb siv cov Atom Publishing standard. Thov xaiv qhov txuas, hauv qab no, saib ib daim ntawv teev cov APIs uas txaus siab, nrog rau cov ntaub ntawv hais.

Yog xav paub ntau ntxiv txog cov ntaub ntawv access

  • Active electric thiab cov nkev Service IDs ntsia thiab nyeem los ntawm PG&E yog tsim nyog tau txais kev tso cai ntawm lub Share Kuv cov ntaub ntawv platform.
  • Yog hais tias qhov kev pab CUAM ID associated nrog ib qho kev tso cai vim yog ib yam ntawm cov txheej xwm, cov kev tso cai yuav hloov mus rau qhov kev pab tshiab ID thiab mus saib tau keeb kwm interval peb cov ntaub ntawv yuav mus ntxiv:
    • Ib ntus kaw vim tsis them cov nqi uas tsis yog-them
    • Txav mus rau Interval Billing
    • txauv ntawm meter
    • Tus nqi hloov
  • Lwm scenarios uas ua rau kev hloov hauv Service ID xws li tsiv mus nyob rau qhov chaw los yog hloov lub tuam txhab yuav txiav txim. Tsis tas li, yog ib tug account yog unlinked ntawm koj tus account zog, tag nrho cov kev pab IDs uas tau tso cai los ntawm Share kuv cov ntaub ntawv yuav unauthorized vim li ntawd.

  • Txiav txim seb cov granularity ntawm kev tso cai interval cov ntaub ntawv, thov siv cov interval Length caij raws li muab los ntawm tus ESPI txheem.
  • PG& E yog muab interval peb cov ntaub ntawv tib granularity li sau rau billing purposes, uas feem ntau yog rau ib teev los yog 15-feeb hauv paus rau cov ntaub ntawv hluav taws xob thiab txhua hnub rau cov ntaub ntawv rau cov neeg muas zaub uas muaj interval meters. Whereas nws yuav txawv ntawm cov neeg muas zaub, hluav taws xob interval meter peb feem ntau muaj nyob rau theem teev rau cov neeg muas zaub thiab ntawm cov 15-feeb interval theem rau cov neeg muas zaub coj mus muag, thiab roj interval meterage yog feem ntau muaj nyob rau theem txhua hnub rau cov neeg muas zaub.
  • Rau cov meters uas tsis yog-interval meters, cov ntaub ntawv yuav muab qhia thaum muaj.

  • Rau feem ntau cov PG&E cov neeg muas zaub nrog ib Smart Meter ntsia, hluav taws xob thiab roj interval peb cov ntaub ntawv yog muaj nyob rau thaum xaus rau hnub tom ntej ntawm lub Share kuv cov ntaub ntawv platform.
  • Qhov me me ntawm PG& E fais cov neeg muas zaub uas muaj hwj huam kab raws li MV90 meters ntsia yuav tsum tau ntxiv sij hawm ntxiv rau cov ntaub ntawv yuav tsum muaj.

  • Thaum peb tsis ncaj qha mus txhawb koj APIs, peb muaj ib tug xov tooj ntawm cov chaw muab kev pab muaj los pab koj thiab kev pab nyob rau hauv txoj kev loj hlob. Thov siv peb cov Nplooj Ntawv API Kom paub ntxiv. Thov hu rau ShareMyData@pge.com uas muaj lus nug ntxiv.

Yog xav paub ntxiv, mus saib hauv kev pab cuam programming interface (API)

Ntxiv rau SmartMeter™

Tiv tauj rau peb

Yog koj muaj lus nug los sis lus, thov email peb pab neeg ntawm ShareMyData@pge.com.

Neeg Muag Khoom

Cov lus qhia rau home Area Network (HAN) ntaus cov neeg muag khoom.

Nyeem ib SmartMeter™

Cov zaub SmartMeter™ qhia tau hais tias ib arrow uas indicates seb koj siv los yog exporting zog.