Важный

Передача моих данных третьим лицам

Предоставление стороннего доступа к данным об энергопотреблении

ícono de aviso importante Примечание: Компьютер перевел эту страницу. Если у вас есть вопросы, позвоните в лингвистические службы по телефону 1-877-660-6789.

Сторонние компании предлагают аналитические инструменты, которые помогут вам сэкономить деньги.

Что такое передача моих данных?

 

«Поделиться моими данными» — это новое поколение инструмента «Подключиться к моим данным с помощью зеленой кнопки».

 

Уже зарегистрированы в качестве утвержденного поставщика Share My Data?

Войдите в систему

 

Кто может использовать раздел «Поделиться моими данными»?

 

  • Коммерческие клиенты
  • Бытовые потребители
  • Университеты и исследователи
  • Поставщики программного обеспечения
  • Запуски энергоснабжения
  • Солнечные компании
  • Агрегаторы Community Choice
  • Ответ на спрос
  • Электрические транспортные средства
  • И многое другое

Поделиться моими данными

Каковы преимущества передачи моих данных?

 

Клиентам больше не нужно входить в свою учетную запись, чтобы неоднократно загружать и отправлять файлы с зеленой кнопкой. Вместо этого, как только клиент уполномочивает вашу компанию на доступ к своим данным учетной записи PG&E, передача осуществляется автоматически и многократно с использованием стандартных интерфейсов прикладного программирования (API). Платформа «Поделиться моими данными» упаковывает данные клиента, уведомляет вашу систему о готовности и безопасной отправке данных.

 

Надежный доступ к данным

Стабильный и надежный доступ к данным через API. Больше нет необходимости «просматривать» или загружать данные.

 

Стандартные API

Национально признанный стандартный формат API интерфейса поставщика энергетических услуг для взаимодействия с другими поставщиками энергии.

 

Выставление счетов и учетная запись

Клиенты PG&E также могут разрешить доступ к информации о выставлении счетов и учетной записи.

 

Количество и качество данных

Доступ ко всем данным об использовании и выставлении счетов из одного источника.

 

Электричество и газ

«Поделиться моими данными» включает в себя данные о интервале клиента PG&E как для использования электроэнергии, так и для использования газа.

 

Открытые инновации

Сценарии использования ограничены только вашим воображением (и несколькими условиями).

 

Начало работы с разделом «Поделиться моими данными»

Существует несколько способов доступа к данным, одобренным клиентом, через API. Наши новейшие API соответствуют действующему стандарту Североамериканского совета по энергетическим стандартам (NAESB) по интерфейсу поставщика энергетических услуг (ESPI) и обеспечивают доступ к информации об использовании энергии (EUI) через набор интерфейсов RESTful.

 

Но сначала необходимо зарегистрироваться для использования платформы «Поделиться моими данными», прежде чем клиенты смогут разрешить вам доступ к своим данным. Для получения доступа выполните следующие действия.

Прежде чем начать процесс регистрации, убедитесь, что у вас есть следующая информация.

 

  • ИНН: ваш 9-значный идентификационный номер работодателя в США (EIN)
  • Контактная информация для бизнеса и технического отдела
  • Унифицированные идентификаторы ресурсов (URI): платформа Share My Data Platform использует протокол OAUth2.0 для авторизации. Если для выбранного типа пользователя требуется трехногий OAuth для доступа к данным, вам необходимо предоставить действительные URI, прежде чем мы сможем принять вашу регистрацию.
    Подробнее о тестировании
  • URI: Вам нужно будет предоставить URI уведомления, чтобы наши системы могли уведомлять Вас о готовности запрашиваемых данных.
    Узнайте больше об URL-адресе уведомления на вкладке доступа к данным
  • Протокол безопасной передачи гипертекста (HTTPS): Вам потребуется получить действительный сертификат TLS1.2 X.509 от признанного поставщика SSL. Самостоятельно подписанные сертификаты не принимаются, и подача самоподписанного сертификата SSL задержит утверждение вашей регистрации.

Процесс регистрации «Передать мои данные» позволяет вам идентифицировать себя в PG&E как компанию или другую организацию, которая хочет получить доступ к данным, разрешенным клиентом, и настроить доступ к нашим API. Существует четыре различных типа пользователей для обмена моими данными. Выберите соответствующий тип пользователя для запрашиваемого доступа.

 

  • Стандартный пользователь: стандартный сторонний пользователь. Тип регистрации: Автономный
  • Пользователь с самостоятельным доступом: физическое лицо или представитель организации, запрашивающей доступ к вашим собственным данным.
  • Энергоэффективное финансирование: организация, предоставляющая услуги, связанные с погашением счетов, финансированием по счетам или программами финансирования энергоэффективности жилья
  • Aggregator Community Choice: зарегистрированный Aggregator Community Choice (CCA) на территории обслуживания PG&E. Чтобы просмотреть список текущих зарегистрированных CCA, перейдите в раздел Агрегация Community Choice .

После сбора всех необходимых элементов зарегистрируйтесь на портале Share My Data API Portal .

Запросы данных и ответы на них выполняются с использованием протокола HTTPS и аутентифицируются посредством двустороннего обмена сертификатами с PG&E. Вам потребуется внедрить сертификаты безопасности для безопасной входящей и исходящей связи API.

Вам также потребуется поддерживать сертификаты RSA с неистекшим сроком действия, неотозванные, с длиной открытого ключа не менее 2048 бит. Сертификат SSL является обязательным условием для завершения тестирования, поэтому убедитесь, что ваш сертификат готов и доступен. В настоящее время PG&E поддерживает только сертификаты SHA-2 X.509, выданные авторитетными органами сертификации (PG&E не принимает самозаверяющие сертификаты), включая AddTrust, Comodo, DigiCert. доверять, GlobalSign, Go Dady,USERTrust и VeriSign.

Как пользователь программы «Передавать мои данные», вы должны согласиться с Условиями и положениями компании PG&E в отношении передачи моих данных, а также принять правила конфиденциальности Комиссии по коммунальным услугам штата Калифорния.

Загрузить Условия и положения обмена моими данными (PDF, 175 КБ)
Загрузить данные о защите конфиденциальности и безопасности использования энергии (PDF)

 

Подтвердить адрес электронной почты

После отправки вашей онлайн-формы регистрации мы отправим электронное письмо на указанный адрес электронной почты контактного лица. Настоящим подтверждаем, что у нас есть ваша правильная контактная информация. Выберите ссылку, содержащуюся в этом электронном письме, в течение пяти дней с момента получения. Если вы этого не сделаете, вам нужно будет повторно отправить регистрационную форму онлайн. После подтверждения адреса электронной почты мы обработаем вашу регистрацию.

Целью тестирования является проверка возможности подключения к нашим системам. После того как мы проверим вашу регистрационную информацию, мы отправим вам электронное письмо с уведомлением о том, что вы можете начать тестирование. Общий процесс тестирования состоит из трех компонентов:

  • Тестирование подключения API
  • Тестирование OAuth
  • Запрос ресурса информации о приложении

Перейдите к инструкциям по тестированию

значок важной информацииПримечание. Тестирование необходимо завершить в течение 90 дней с момента получения уведомления.

После завершения тестирования вы получите электронное письмо с подтверждением успешного завершения тестирования. После окончательного рассмотрения статус вашей регистрации будет изменен на «Утверждено». На этом этапе вы можете получить доступ к данным и, если ваш тип пользователя разрешает вам доступ к данным клиента, клиент сможет предоставить вам авторизацию. Кроме того, клиенты, разрешившие раскрытие их данных, смогут увидеть, что у вашей организации есть доступ. Если вы хотите отключить видимость клиентов, вы можете сделать это на стороннем портале.

Чтобы узнать о процессе авторизации, посетите страницу «Обзор авторизации клиентов».

Перейти к сведениям об авторизации

Предварительные условия

Для доступа к нашим API необходимо выполнить следующие предварительные условия:

 

  1. Вы должны зарегистрироваться, чтобы использовать платформу Share My Data, прежде чем клиенты смогут разрешить вам доступ к своим данным. Если вы не зарегистрировались, зарегистрируйтесь и завершите тестирование.
  2. Вы должны были получить электронное письмо с уведомлением о том, что ваша регистрация принята. Если вы не получили это письмо, войдите в свою учетную запись «Поделиться моими данными» и выберите «Управление регистрацией», чтобы просмотреть статус регистрации.

 

Важно пройти тестирование в течение 90 дней с момента принятия регистрации. Если вы не можете пройти тестирование в течение 90 дней, срок вашей регистрации истечет, и вам потребуется пройти повторную регистрацию.

 

значок важной информацииВажно: За исключением переадресаций браузера во время OAuth 2.0, все остальные запросы между вами и PG&E являются взаимными SSL и требуют, чтобы вы прикрепили сертификат SSL клиента к вашему запросу. (Это должен быть тот же сертификат, который вы отправили в PG&E, прежде чем его примут.)

Для завершения тестирования подключения API требуются следующие типы пользователей:

Стандартный пользователь, самостоятельный доступ, финансы энергоэффективности и агрегатор выбора сообщества

Цель:

Целью Теста подключения API является обеспечение возможности подключения к API Share My Data.

Рекомендуется: Получение токена клиентского доступа с помощью пользовательского интерфейса SOAP
Пример шагов для выполнения первого этапа тестирования подключения (получения токена клиентского доступа) с помощью инструмента пользовательского интерфейса SOAP.
Загрузите SOAP UI Tool (PDF, 520 КБ).

Поскольку варианты реализации могут варьироваться, это предназначено только для того, чтобы помочь проиллюстрировать, как следует выполнять подключения API к PG&E через взаимный (2-сторонний) SSL.

Этапы проверки подключения API:

Для начала загрузите сертификат PG&E Entrust SSL, войдя в свою учетную запись. Затем выберите «Управление регистрацией», чтобы получить

контрольные точки регистрации

Используйте учетные данные клиента для получения токена доступа клиента:

  • Подайте запрос POST на TEST authorizationServerTokenEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/token
  • Добавить параметр grant_type=client_credentials.
  • Добавить базовый параметр заголовка авторизации по Base64, кодирующему "client_ID:client_Secret." Параметр заголовка будет иметь следующий формат:
    Название параметра: Авторизация
    Значение параметра: Базовая "закодированная строкаbase64"
  • Ответ даст вам токен доступа клиента и его срок действия (например):
          <Ответ xmlns="https://api.pge.com/datacustodian/oauth/v2/token">
          c03a9825-16f7-400a-b546-9a206ab995db
          3600
          3
          Несущий
         

Используйте токен доступа клиента для вызова API статуса службы:

  • Сделайте запрос на получение по этому URL-адресу:
    https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ReadServiceStatus
  • Передача маркера доступа клиента в заголовке авторизации в формате ниже:
    Имя параметра заголовка = Авторизация
    Значение = Предъявитель
  • Ответ должен быть следующим:
         
          1
         

Используйте токен доступа клиента для запроса данных образца:

  • Сделайте запрос на получение по этому URL-адресу:
    https://api.pge.com/GreenButtonConnect/espi/1_1/resource/DownloadSampleData
  • Передача маркера доступа клиента в заголовке авторизации в формате ниже:
    Имя параметра заголовка = Авторизация
    Значение = Предъявитель
  • Ответ должен быть следующим:Пример показаний счетчика загрузки (XML, 273 КБ)

    После успешного получения пробных данных вы пройдете тест подключения API и увидите сообщение «Тест подключения API: «Завершено» в таблице контрольных точек регистрации, как показано ниже.

контрольные точки регистрации 2

Следующие пользователи должны пройти тестирование OAuth:

Стандартное финансирование эффективности использования и энергопотребления

Цель:

Целью теста OAuth является обеспечение правильной работы вашей реализации OAuth.

значок важной информацииПримечание:

Для целей этого теста ваше приложение должно быть направлено на следующие конечные точки, чтобы запросить «код авторизации теста» и «токен доступа к тесту»:

  • authorizationServerAuthorizationEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/authorize
  • Авторизация TESTServerTokenEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/token

Указания по тестированию OAuth:

  • Войдите на портал Share My Data Third-Party Portal
  • Нажмите "Go>" в поле OAuth Test
  • Тест OAuth откроется в новом окне. Обратите внимание, что если он не открывается, убедитесь, что блокировка всплывающих окон выключена или отключена.
  • Выберите СТАРТ: При выборе СТАРТ вы начнете тест OAuth, и правильное выполнение будет следовать следующей последовательности перенаправлений.

    Проверка OAuth ShareMyData:

    Выдает 302 перенаправление на URL OAuth (ThirdPartyPortalURI), который вы предоставили во время регистрации, с параметрами фиктивной области:
    Пример:{ThirdPartyPortalURI}?scope=xxx&ThirdPartyID={dataCustodianId}

    Ваше заявление:

    Дополнительно:Ваше приложение: Подсказки (клиент) для входа на веб-сайт вашего приложения

    Ваше заявление:

    Выдает перенаправление 302 на и делает запрос GET для кода авторизации:

    Например, используйте эту ссылку ТОЛЬКО ДЛЯ ИСПЫТАНИЙ:

    ПОЛУЧИТЕ https://api.pge.com/datacustodian/test/oauth/v2/authorize?client_id={значение идентификатора клиента в поле RegistrationMilestones}&redirect_uri={redirect_uri}&scope={scope}&response_type=code

    Например, используйте эту ссылку ТОЛЬКО для ПРОИЗВОДСТВА:

    GEThttps://sharemydata.pge.com/myAuthorization?client_id={значение идентификатора клиента в поле RegistrationMilestones}&redirect_uri={redirect_uri}&response_type=code&state={optionalState}

    Проверка OAuth ShareMyData:

    Выдает 302 перенаправление на , который вы предоставили во время регистрации с имитацией кода авторизации:

    Пример: https://thirdparty.com/redirectUrl?authorization_code=7afc7c4f-778a-4ad8-8337-5e19218a2219

    Ваше приложение: Сделайте запрос POST для токена доступа, используя полученный код авторизации и позвонив в :

    значок важной информацииПримечание. Для запроса токена доступа необходимо приложить сертификат SSL.
    Пример:

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

    Добавить базовый параметр заголовка авторизации по Base64, кодирующему «client_ID:client_Secret»

    Параметр заголовка будет иметь следующий формат:

    • Название параметра: Одобрение
    • Значение параметра: Базовая "закодированная строкаbase64"

    Проверка OAuth ShareMyData: Отвечает тестовым токеном доступа:

    Успешный ответ будет выглядеть следующим образом:
    "токен_доступа":" 774ff105-7ad5-40c8-a6ec-f60675dc0e41"
    "срок действия_in":"3600"
    "refresh_token":998c6654-5b3b-4385-af4f-4e5c46c1bb04
    "scope":"{ScopeString}"
    "resourceURI":"{ResourceURI}"
    "authorizationURI":"{AuthorizationURI}"
    "token_type":"Bearer"

На этом этапе вы успешно пройдете тест OAuth и увидите сообщение «Тест OAuth: «Завершено» в таблице этапов регистрации, как показано ниже:

контрольные точки регистрации

значок важной информацииВажно: после завершения тестирования вы должны перенаправить ваше приложение на производственные конечные точки для кода авторизации и запроса токена доступа, чтобы клиенты могли разрешить вам доступ к своим данным. Эти конечные точки будут предоставлены Вам в Информационном ресурсе приложения.

Для создания запроса ресурса информации о приложении требуются следующие типы пользователей:

Стандартное финансирование эффективности использования и энергопотребления

Цель:

Цель запроса ресурса информации о приложении — обеспечить получение производственных URL-адресов для авторизацииServerEndpoint и authorizationServerTokenEndpoint вместе с dataCustodianScopeSelectionScreenURI

Шаги запроса ресурса информации о приложении:

Для запроса ресурса информации о приложении вам потребуется ваш Токен доступа к регистрации и идентификатор информации о приложении.

Получить токен доступа для регистрации

Чтобы получить ваш Токен доступа для регистрации, войдите в свою учетную запись «Поделиться моими данными» и выберите «Управление регистрацией». Ваш <Токен доступа к регистрации> будет отображаться в таблице «Контрольные точки регистрации» после принятия регистрации.

контрольные точки регистрации

Идентификатор получения информации о приложении

Используйте токен клиентского доступа, полученный во время теста подключения API, чтобы вызвать Authorization xml:
Сделайте запрос GET по этому URL-адресу:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization

Передача маркера доступа клиента в заголовке авторизации в формате ниже:
Имя параметра заголовка = Авторизация
Значение = токен доступа на предъявителя <клиентский токен>
В ответе вы увидите идентификатор информации о приложении:

контрольные точки регистрации

Запрос информационного ресурса приложения

Позвоните в оконечную точку Application Information с GET по следующему URL-адресу: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ApplicationInformation/{ApplicationInformationID}.
Заменить {ApplicationInformationID} идентификатором информации о приложении, которую вы получили
Добавить базовый параметр заголовка авторизации. Параметр заголовка будет иметь следующий формат:

Название параметра: Авторизация
Значение параметра: Предъявитель
В ответе будет предоставлен информационный ресурс приложения

значок важной информацииВажно: Инструкции по заполнению подписи см. в Соглашении о внедрении зеленой кнопки .

Информационный ресурс приложения будет содержать следующую информацию:

  • DataCustodianId
  • dataCustodianApplicationStatus
  • Стороннее приложениеОписание
  • Тип приложения третьей стороны
  • Третья сторонаТелефон
  • authorizationServerUri
  • Уведомление третьей стороныUri
  • authorizationServerAuthorizationEndpoint
  • authorizationServerTokenEndpoint
  • dataCustodianBulkRequestURI
  • dataCustodianResourceEndpoint
  • третьей сторонеScopeSelectionScreenURI
  • URI портала третьего лица
  • клиент_секрет
  • имя_клиента
  • переадресация_uri
  • идентификатор_клиента
  • идентификатор_программного обеспечения
  • версия_программного обеспечения
  • Идентификатор_клиента_выдан_в
  • клиент_срок действия_секретаря_в
  • контакты
  • метод_аута_конечной_точки_токена
  • область применения
  • типы_предоставления
  • типы_предоставления
  • типы_предоставления
  • типы_ответа
  • регистрация_клиента_uri
  • маркер_доступа_регистрации
  • dataCustodianScopeSelectionScreenURI

Если вы являетесь стандартным пользователем или пользователем отдела по вопросам энергоэффективности, это последнее из трех требований к тестированию, и после проверки ваша регистрация будет перемещена в раздел «Утверждено», как показано ниже. С помощью Утвержденной регистрации клиенты теперь могут разрешить вам доступ к своим данным через свою учетную запись My Energy или переадресовывать их через ваш веб-сайт с использованием , предоставленного вам в запросе на предоставление информации о приложении.

значок важной информацииВажно: чтобы клиенты могли разрешить вам доступ к своим данным, необходимо перенаправить ваше приложение на производственные конечные точки для кода авторизации и запроса токена доступа. Эти конечные точки предоставляются вам в Информационном ресурсе приложения.

контрольные точки регистрации

Чтобы узнать больше о том, как клиенты предоставляют третьим лицам доступ к своим данным о разрешении на посещение .

После получения разрешения клиента вы можете начать использовать наши API для доступа к авторизованным данным. Для получения дополнительной информации посетите страницу доступа к данным .

Предварительные условия

Для доступа к нашим API необходимо выполнить следующие предварительные условия:

 

  1. Вы должны зарегистрироваться, чтобы использовать платформу «Поделиться моими данными», прежде чем клиенты смогут разрешить вам доступ к своим данным. Если вы не зарегистрированы, зарегистрируйтесь и завершите тестирование.
  2. Вы должны были пройти тестирование API Connectivity и OAuth. Если Вы еще не завершили тестирование, см. инструкции по тестированию.
    значок важной информацииПримечание. Этапы тестирования OAuth будут обновлены в будущем выпуске для отражения новейших функций OAuth 2.0, описанных ниже (т. е. удаление третьей стороныPartyScopeSelectionScreenURI).
    Подробная информация об анализах на визитах

Процесс авторизации

Для соответствия действующему стандарту авторизации Североамериканского совета по энергетическим стандартам (NAESB) по интерфейсу поставщика энергетических услуг (ESPI), PG&E внедрила систему авторизации OAuth 2.0 для авторизации доступа к данным. На приведенной ниже схеме показано, как клиенты инициируют авторизацию, выбирают параметры объема, а затем отправляют авторизацию.

Дополнительные справочные материалы помимо приведенной ниже информации:

Загрузить схему последовательности ESPI OAuth 2.0 (PDF, 193 КБ)
Просмотр SDK данных о зеленой кнопке в Github

значок важной информацииПримечание. Для агрегаторов Community Choice для запроса данных требуется только токен Client_access_token (через 2-Legged OAuth), и следующее не применяется.

Diagram of Authorization process initiated at a third-party site

Diagram of authorizations initated at PG&E

Шаги по запросу разрешения

Разрешения, инициированные на стороннем объекте

Чтобы начать авторизацию с стороннего сайта, как показано на первой схеме выше, запрос на авторизационный код выполняется путем перенаправления браузера клиента с вашего стороннего сайта на URL-адрес конечной точки авторизации PG&E с соответствующими параметрами запроса, как показано ниже. После перенаправления клиенту будет представлена страница входа в PG&E для аутентификации, после которой будет представлена страница авторизации для авторизации доступа к данным вашей третьей стороны:

authorizationServerAuthorizationEndpoint URI (с параметрами запроса)
https://sharemydata.pge.com/myAuthorization?client_id=A1b2C3&redirect_uri={redirect_uri}&response_type=code&state={optionalState}

  • Обязательные параметры запроса:
    • Client_id = идентификатор клиента из контрольных точек регистрации «Поделиться моими данными» (т. е. пара клиент_идентификатор/клиент_секрет).
    • redirect_uri = URL-адрес перенаправления, указанный при регистрации «Поделиться моими данными» (URL-адреса должны совпадать).
      значок важной информацииПримечание. Мы рекомендуем применить кодировку URL к redirect_uri, как показано в примере ниже.
    • response_type = код (статическое значение)
  • Дополнительный параметр(-ы) запроса:
    • состояние = необязательный непрозрачный параметр состояния, разрешенный стандартом OAuth 2.0, который возвращается с кодом авторизации, чтобы помочь поддерживать состояние. Например, параметр состояния может быть использован третьей стороной для уникальной идентификации происхождения клиента и предотвращения подделки на другом объекте.
    • login={guest} Предоставьте третьему лицу возможность перенаправить клиентов на вход в систему My Energy PG&E или на вкладку Guest Access в рамках процесса онлайн-авторизации.

ПРИМЕР: Запрос кода авторизации

ПОЛУЧИТЬ: https://sharemydata.pge.com/myAuthorization?client_id=A1b2C3&redirect_uri=https%3A%2F%2Fthirdparty.com%2FredirectUrl&response_type=code&state=pge12advertisement

значок важной информацииПримечание: приведенный выше пример параметра redirect_uri содержит кодировку URL-адреса (т. е. кодировку URL-адреса https://thirdparty.com/redirectUrl)

Если вы сделаете действительный запрос, как указано выше, и клиент успешно аутентифицирует и авторизует клиента, то клиент будет перенаправлен на ваш redirect_uri с кодом авторизации, параметром (авторизованным) области и дополнительным параметром состояния (если он предоставлен как часть запроса авторизации), как показано ниже:

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;AdditionalScope=Usage_Billing_Basic_Account_ProgramEnrollment;IntervalDuration=900_3600;Длительность блокировки=Ежедневно;Длина истории={3P Зарегистрированная длина};Сбор учетной записи={count of authorizedSAs};BR={ThirdPartyID};dataCustodianId=PGE &state=pge12реклама

значок важной информацииПримечание. Код авторизации является кратковременным (истекает через 600 секунд), и его необходимо впоследствии обменять на пару токенов доступа/обновления токенов, чтобы завершить авторизацию и разрешить доступ к текущим данным. См. следующий раздел (раздел 2) для получения подробной информации о запросе токена доступа/обновления токена.

Параметр (авторизованный) области, приведенный выше, возвращается как часть ответов на запрос кода авторизации, запрос токена доступа, а также API авторизации. Этот параметр объема позволяет передавать окончательный объем авторизации клиента. В частности, параметр области включает значение «Дополнительный объем», которое отображается в поддерживаемых PG&E вариантах авторизации клиентов групп данных (например, «Использование», «Выставление счетов», «Базовый», «Учетная запись», «Регистрация программы»). Значения параметров осциллографа дополнительно фиксируются в соответствии со следующей справочной документацией:Скачать сопоставление строк осциллографа поддерживаемого функционального блока Click Thru 2.0 (PDF, 222 КБ).

Сценарии ошибок

Ошибки внедрения третьей стороны: если требуемые параметры запроса client_id или redirect_uri недействительны или отсутствуют при запросе кода авторизации, клиенту будет показано пояснительное сообщение вместе со стандартной ошибкой серии HTTP 400. Аналогичным образом, если требуемый параметр запроса response_type отсутствует или недействителен, клиент будет перенаправлен обратно на ваш redirect_uri с заданным OAuth 2.0 параметром ошибки «invalid_request», а также дополнительным параметром состояния, если он был впервые предоставлен как часть исходного запроса авторизационного кода.

Клиенты, отказывающиеся авторизовать: после того, как третья сторона перенаправляет клиента на авторизацию в PG&E, клиент имеет возможность отказаться с помощью кнопки «Отмена» на странице входа и странице авторизации. В таких случаях клиент будет перенаправлен обратно на ваш redirect_uri с параметром ошибки OAuth 2.0, который был добавлен в качестве параметра «access_denied», указывающего на то, что клиент отказался авторизовать его. Кроме того, необязательный параметр состояния будет возвращен, если он сначала предоставлен как часть исходного запроса на код авторизации.

Авторизации, инициированные в PG&E

Когда клиенты начинают работу на веб-портале для клиентов PG&E «Ваша учетная запись», а затем переходят на целевую страницу «Поделиться моими данными», они получают выпадающий список зарегистрированных и видимых третьих сторон. Как показано на второй схеме выше, после того как клиент выберет третью сторону из списка зарегистрированных третьих сторон и выберет «Далее», клиент будет перенаправлен на зарегистрированный URI портала третьей стороны, после чего клиенты смогут перейти к процессу OAuth, инициированному третьей стороной, описанному в предыдущем разделе.

значок важной информацииПримечание. Некоторые третьи стороны спросили о том, как оптимизировать взаимодействие с клиентами для этого сценария использования (т. е. авторизации, инициированные на сайте PG&E), чтобы клиент мог сразу перейти на страницу авторизации при выборе третьей стороны из выпадающего списка. Для облегчения такого клиентского опыта третьи стороны могут выбрать параметр «URI стороннего портала» (через страницу регистрации управления разделом «Поделиться моими данными») для конечной точки, которая автоматически перенаправляет клиента обратно в PG&E в рамках запроса на авторизационный код. После автоматического перенаправления обратно на конечную точку авторизации сервера авторизации PG&E клиент пропустит страницу входа клиента (поскольку он уже вошел в систему) и перейдет непосредственно на страницу авторизации. Для некоторых третьих лиц, которые зарегистрировались до выпуска «Передача моих данных» в конце июня 2018 года, это можно сделать, просто задав URI портала для третьих лиц, чтобы он был равен больше не используемому URI «Экрану выбора области действия третьих лиц» (поле будет выведено из обращения в будущем).

В отличие от этого, некоторые третьи стороны могут сначала привлекать и проверять клиентов на своей стороне, когда клиенты перенаправляются на свой URI «Портал для третьих сторон» перед запросом авторизационного кода, поэтому вышеуказанный подход является лишь предложением.

Чтобы получить токен доступа, используйте полученный код авторизации и вызовите указанную ниже конечную точку с параметрами запроса, как описано ниже. Как описано выше, Авторизационный код краткосрочный и истекает через 10 минут (600 секунд), поэтому убедитесь, что Токен доступа незамедлительно запрашивается после получения Авторизационного кода.

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

  • Обязательные параметры запроса:
    • grant_type = код авторизации (статическое значение)
    • код = авторизационный код, полученный в ответ на запрос авторизационного кода
    • redirect_uri = URL-адрес перенаправления, указанный при регистрации «Поделиться моими данными» (URL-адреса должны совпадать).
      значок важной информацииПримечание. Как и в случае с запросом на авторизационный код, мы рекомендуем применить кодировку URL к redirect_uri.

ПРИМЕР: Запрос токена доступа
ПОСТ: https://api.pge.com/datacustodian/oauth/v2/token?grant_type=authorization_code&code={authorizationcode}&redirect_uri={redirect_uri}

Добавить базовый параметр заголовка авторизации с примененным кодированием Base64 «clientID:clientSecret»

значок важной информацииПримечание. Значения clientId:clientSecret соответствуют значениям clientID, указанным в контрольных точках регистрации «Поделиться моими данными».
Параметр заголовка будет иметь следующий формат:
Название параметра: Авторизация
Значение параметра: Базовая "закодированная строкаbase64"

Успешный ответ будет выглядеть следующим образом:

<Ответ xmlns="https://api.pge.com/datacustodian/oauth/v2/token">
774ff105-7ad5-40c8-a6ec-f60675dc0e41
3600
998c6654-5b3b-4385-af4f-4e5c46c1bb04
scope=FB=1_3_8_13_14_18_19_31_32_35_37_38_39_40_4_5_10_15_16_46_47; AdditionalScope=Usage_Billing_Basic_Account_ProgramEnrollment;IntervalDuration=900_3600;BlockDuration=Daily;HistoryLength={3P Registered Historical length};AccountColle Collection={count of authorized SAs};BR={ThirdPartyID};dataCustodianId=PGE
ресурсURI:{ResourceURI}, например: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{subscriptionID}
URI авторизации:{AuthorizationURI}, например: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{authorizationID}
CustomerResourceURI:{customerResourceURI}, например:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
Несущий

значок важной информацииПримечание. Срок действия токена доступа истекает через 3600 секунд (1 час), а срок действия соответствующего обновления токена истекает через 1 год. См. следующий раздел 3 для получения подробной информации о получении новой пары токен доступа/Обновить токен.

Сохраните пару токенов доступа и обновите ее.
Чтобы запросить исходные исторические данные и текущие ежедневные данные, посетите раздел «Доступ к данным».

В соответствии с передовой практикой токен доступа представляет собой кратковременный токен (1 час), в то время как соответствующий «Обновить токен» представляет собой долгосрочный токен (1 год), который можно использовать для получения новой пары «Токен доступа/Обновить токен» по истечении срока действия токена доступа. Чтобы получить новую пару токенов доступа и Обновить токен для существующих авторизации с неистекшим сроком действия, используйте «текущий Обновить токен» и вызовите указанную ниже конечную точку с параметрами, описанными ниже.

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

ПРИМЕР: Запрос на обновление токена
ПОСТ: https://api.pge.com/datacustodian/oauth/v2/token?grant_type= refresh_token&refresh_token={current_refresh_token}

Добавить базовый параметр заголовка авторизации с примененным кодированием Base64 «clientID:clientSecret»

значок важной информацииПримечание. Значения clientId:clientSecret соответствуют значениям clientID, указанным в контрольных точках регистрации «Поделиться моими данными».
Параметр заголовка будет иметь следующий формат:
Название параметра: Авторизация
Значение параметра: Базовая "закодированная строкаbase64"

Успешный ответ будет выглядеть следующим образом:
{
"токен доступа": "677e6ef8-1e1a-43f0-85b8-5692fcbc72b2",
"тип_токена": "Несущий",
«срок действия_in»: 3600,
"resh_token": "0eef9a9f-60c6-40bb-b33f-910e322c0298",
"scope": "scope=FB=1_3_8_13_14_18_19_31_32_35_37_38_39_40_4_5_10_15_16_46_47; AdditionalScope=Usage_Billing_Basic_Account_
Регистрация в программе;IntervalDuration=900_3600;BlockDuration=Daily;HistoryLength={3P Registered Historical length};AccountCollection={count of authorized 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"
}

значок важной информацииПримечание. Аналогичным образом, токен клиентского доступа представляет собой кратковременный токен (1 час), в то время как его соответствующий «Обновить токен» представляет собой долгосрочный токен (1 год), который можно использовать для приобретения новой пары «Токен клиентского доступа/Обновить токен» по истечении срока действия токена клиентского доступа. Для получения новой пары токен Client Access/Обновить токен выполните описанные выше действия.

Обновление и управление разрешениями

Клиенты смогут обновить свои разрешения, выполнив следующие действия:

  • Удаление идентификаторов служб из их авторизаций
  • Продление даты окончания периода авторизации
  • Отмена авторизации

значок важной информацииПримечание. Клиенты смогут вносить изменения в свои авторизации только путем входа в свою учетную запись PG&E в Интернете и выполнения необходимых шагов. В случае выполнения любого из этих действий мы уведомим вас через URI уведомления, который вы предоставили во время регистрации.

Существуют варианты управления и просмотра сведений о ваших авторизациях клиентов:

  • Вы можете позвонить в API авторизации (функция http GET), используя свой токен Client_access_token, либо на уровне третьей стороны (для получения подробной информации обо всех авторизациях) по адресу https://api.pge.com/GreenButtonConnect /espi/1_1/resource/Authorization, либо на уровне авторизации отдельного клиента по адресу https://api.pge.com/GreenButtonConnect /espi/1_1/resource/Authorization/{AuthorizationID}.
  • Кроме того, вы можете просматривать индивидуальные данные авторизации вручную, войдя в свою учетную запись «Поделиться моими данными» на стороннем портале и введя идентификатор подписки для авторизации, которую вы ищете.

Если вы больше не хотите получать доступ к данным, связанным с авторизацией, существуют необязательные методы отмены авторизации:

  • Вы можете позвонить в API отзыва авторизации (операция http DELETE), используя свой токен Client_access_token на сайте https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{AuthorizationID}.
  • Вы также можете вручную отменить авторизацию, войдя в свою учетную запись «Поделиться моими данными» на стороннем портале и введя идентификатор подписки для авторизации, которую вы хотите отменить.

значок важной информацииПримечание. Клиент получит уведомление о том, что вы решили отменить его авторизацию. Кроме того, после отмены авторизации действие нельзя отменить.

Предварительные условия

Для доступа к нашим API необходимо выполнить следующие предварительные условия:

  1. Вы должны зарегистрироваться, чтобы использовать платформу «Поделиться моими данными», прежде чем клиенты смогут разрешить вам доступ к своим данным.
  2. Вы должны были пройти тестирование API Connectivity и OAuth. Если Вы еще не завершили тестирование, см. инструкции по тестированию.
    Подробная информация об анализах на визитах
  3. Если ваш тип пользователя требует авторизации клиента для доступа к данным, убедитесь, что клиент предоставил вам разрешение на доступ к его данным и что вы обменяли код авторизации на токен доступа. Если вы еще не получили разрешение клиента, просмотрите процесс авторизации клиента.
    Перейти к сведениям об авторизации

Общие сведения

Существует несколько способов доступа к данным, одобренным клиентом, через API. Наши новейшие API соответствуют действующему стандарту Североамериканского совета по энергетическим стандартам (NAESB) по интерфейсу поставщика энергетических услуг (ESPI) и обеспечивают доступ к информации об использовании энергии (EUI) через набор интерфейсов RESTful

Загрузить поддерживаемые API (PDF, 217 КБ)

В документе «Поддерживаемые API» показаны API, поддерживаемые внедрением PG&E «Поделиться моими данными», а также URL-адрес API для PG&E.

Загрузить сопоставление строк области поддерживаемого функционального блока (PDF, 222 КБ)

Документ «Сопоставление области действия поддерживаемого функционального блока» содержит сведения о строке области, которая возвращается в рамках ответов на запрос кода авторизации, запрос токена доступа, а также API авторизации, как описано в обзоре сведений об авторизации . Параметр «Область» позволяет передавать окончательную область авторизации клиента. Кроме того, в этом документе указано, какая стандартная функция ESPI блокирует поддержку PG&E в реализации «Поделиться моими данными».

Загрузите поддерживаемую модель реляционных данных (реализация ESPI в PG&E) (PDF, 482 КБ).

В сочетании с документом «Поддерживаемые элементы данных» модель поддерживаемых реляционных данных иллюстрирует, как взаимосвязь между различными элементами данных PG&E фиксируется стандартом ESPI.

Загрузить поддерживаемые элементы данных (PDF, 283 КБ)

Документ «Поддерживаемые элементы данных» предоставляет сопоставление между элементами стандартных данных ESPI и элементами данных PG&E.
Реализация PG&E совместима с определениями схем, предоставленных ESPI, которые можно найти в GitHub. В частности, в нашей текущей реализации используются следующие версии схем:

Загрузить XSD (ZIP, 50 КБ)
Посетить Github

Ознакомьтесь со следующими источниками информации о том, как завершить подпись для каждого запроса API и протестировать вызов API в соответствии с «песочницей» API GBC:

Посетите библиотеку документов с зеленой кнопкой
Посетите API зеленой кнопки

URI уведомления

Во время регистрации вам необходимо будет предоставить URI уведомления, чтобы наши системы могли уведомлять вас о любых изменениях в ваших авторизациях (например, отмене клиента), в случае асинхронных запросов данных (только для больших наборов данных) и когда запрошенные вами данные будут готовы. Кроме того, если вы хотите получать ежедневные уведомления по подписке о последних доступных данных плюс исправления предыдущих данных за последние 24 часа, установите флажок Уведомить меня, поскольку данные готовы при регистрации. Мы предварительно упакуем данные за последний день и уведомим вас в вашем URI уведомления о возвращении и получении данных.

значок важной информации Примечание. Если вы не намерены извлекать данные ежедневно, мы просим вас не проверять опцию Уведомить меня, поскольку данные готовы, чтобы уменьшить объем ненужных данных, которые мы обрабатываем. Вы по-прежнему сможете делать специальные запросы на получение данных.

  • PG&E будет отправлять уведомления на ваш URI уведомления, предоставленный во время регистрации. Уведомления содержат URI, соответствующие уже упакованным данным, готовым к возвращению и запросу по указанным URL-адресам. Данные предварительно упакованы и уведомления отправляются в следующих двух сценариях: (1) вы выбрали «Уведомить меня о готовности данных» в своем профиле регистрации, в этом случае мы упакуем последние ежедневные данные с любыми исправлениями за прошлые даты; или (2) вы ранее сделали специальный асинхронный запрос, для которого запрошенные данные теперь готовы.
  • Сценарий 1 показан в разделе «DATA ACCESS: ЕЖЕДНЕВНАЯ ПОДПИСКА» нижеприведенных диаграмм «Методы доступа к данным» и сценарий 2 проиллюстрированы в разделе «ДАННЫЙ ДОСТУП: AD HOC REQUEST (ASYNCHRONOUS)», раздел тех же диаграмм ниже.

Методы доступа к данным

Data Access: Daily Subscription Model

Примеры запросов данных

Пожалуйста, помните о сроке действия токенов доступа, токенов клиентского доступа и их соответствующих Обновить токены, используемых в запросах данных. Согласно передовой практике, токен доступа представляет собой кратковременный токен (1 час), в то время как токен обновления представляет собой долгосрочный токен (1 год), который вы можете использовать для получения новой пары токенов доступа/обновления токена по истечении срока действия токена доступа. Аналогичным образом, токен клиентского доступа представляет собой кратковременный токен (1 час), в то время как его соответствующий «Обновить токен» представляет собой долгосрочный токен (1 год), который можно использовать для получения новой пары «Токен клиентского доступа/Обновить токен» по истечении срока действия токена клиентского доступа. Для получения более подробной информации о получении новой пары маркеров см. Шаг 3, Запрос нового маркера доступа, на нашей вкладке «Сведения об авторизации». Перейти к сведениям об авторизации

Если клиент уполномочил вас на получение «Информации об учетной записи» (Идентификаторы учетной записи, Идентификаторы соглашений об обслуживании и даты начала обслуживания) и/или «Основной информации» (т. е. имя клиента и адрес обслуживания), вы можете запросить такую информацию о клиенте через API, определенные ESPI RetailCustomer, для которых данные соответствуют схеме RetailCustomer.xsd, представленной выше.

Синхронный (стандартные и EEF сторонние)

Одним из подходов к запросу данных клиента является использование синхронного API для запроса информации клиента для авторизации одного клиента для данных клиента (т. е. розничного клиента):

Пример URL-адреса синхронного запроса:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}

RetailCustomerID = RetailCustomerID, полученный в конце последовательности авторизации OAuth для получения токена доступа. RetailCustomerID является частью параметра пути customerResourceUri в ответе на токен. (RetailCustomerID=SubscriptionID)

HTTP Header = Авторизация:Предъявитель {токен доступа для этой авторизации}

Ответ = вы синхронно получите данные для этого RetailCustomerID. Данные соответствуют файлу retailCustomer.xsd

значок важной информацииПримечание. Синхронный API розничного клиента находится на уровне отдельного розничного клиента, что соответствует одному разрешению клиента.

Для справки: иерархическая диаграмма ниже показывает иерархию отношений для элементов данных ESPI при моделировании данных клиентов PG&E.

Вы также можете запросить данные клиентов через асинхронный API для запроса информации о клиентах для всех ваших авторизаций клиентов для данных клиентов (т. е. розничных клиентов).

Для поддержки асинхронных запросов ваше приложение должно будет поддерживать пост-уведомления, которые мы отправим вам (в соответствии с URL-адресом уведомления, который вы указали во время регистрации).

Пример URL-адреса асинхронного запроса:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}

BulkID = BulkID, предоставленный в ресурсе ApplicationInformation Resource, полученном во время регистрационных испытаний. (BulkID=ClientID)

HTTP-заголовок = авторизация:Несущий {токен доступа клиента, полученный во время регистрационных испытаний}

Ответ = код состояния HTTP 202 (это асинхронный запрос, при котором ответ будет размещен на URL-адресе уведомления, когда данные будут готовы). Как только данные будут готовы, мы РАЗМЕСТИМ уведомление на предоставленный вами URI уведомления с полезными данными URL-адресов, которые ваше приложение может вернуть, чтобы получить предварительно упакованный файл. Пример уведомления после публикации выглядит следующим образом

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

 

Выполните GET по указанному выше URL-адресу с помощью токена Client Access, чтобы получить данные.

Для справки: иерархическая диаграмма ниже показывает иерархию отношений для элементов данных ESPI при моделировании данных клиентов PG&E.

Наконец, вы можете ежедневно получать самую последнюю информацию о клиенте, используя модель ежедневной подписки (т. е. установив флажок «Уведомить меня о готовности данных (ежедневно)» во время регистрации).

Для поддержки модели ежедневной подписки ваше приложение должно будет поддерживать отправку вам уведомлений (в соответствии с URL-адресом уведомления, предоставленным вами при регистрации).

Как только данные будут готовы, мы РАЗМЕСТИМ уведомление на предоставленный вами URI уведомления с полезными данными URL-адресов, которые ваше приложение может вернуть, чтобы получить предварительно упакованный файл. Пример после уведомления выглядит следующим образом:

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

Выполните GET по указанному выше URL-адресу с помощью токена Client Access, чтобы получить данные.

Для справки, на иерархической диаграмме ниже показана иерархия отношений для элементов данных ESPI при моделировании данных клиентов PG&E.

Если клиент уполномочил вас на получение «Информация об использовании» и/или «Информация о выставлении счетов», вы можете запросить эти данные через API подписки, для которых данные соответствуют схеме, espiDerived.xsd, представленной выше.

Синхронные специальные запросы (стандартные и EEF сторонние организации)

Для запроса хронологических данных (как для данных об использовании интервала, так и данных о счетах) один подход заключается в использовании синхронных API с включением надлежащих параметров запроса даты начала и окончания в время Zulu.

Пример URL-адреса синхронного запроса:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}?опубликовано-мин={startDate}&опубликовано-макс={endDate}

опубликовано-min = дата начала, которая будет применена к этому запросу для извлечения данных. Дата указана в формате Zulu гггг-ММ-ддТГ:мм:ссЗ (формат IEEETC RFC 3339)

опубликовано-макс. = дата окончания, которая будет применена к этому запросу на извлечение данных. Дата указана в формате Zulu гггг-ММ-ддТГ:мм:ссЗ (формат IEEETC RFC 3339)

значок важной информацииПримечание. Для запросов API, которые принимают параметры "публикация-макс" и "публикация-мин", по умолчанию используется T-1 (дата запроса минус 1 день). Для запросов сводных данных об использовании (например, .../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/UsageSummary) мы предлагаем предоставить диапазон от 30 дней, чтобы обеспечить наличие счета, который перекрывает этот период, в противном случае данные не будут возвращены.

Идентификатор подписки = Идентификатор подписки, полученный в конце последовательности авторизации OAuth для получения токена доступа. ID подписки является частью параметра resourceURI в ответе маркера. (SubscriptionID=RetailCustomerID)

UsagePointID = UsagePoint под указанным выше идентификатором подписки. Вы можете получить все точки использования для данной Подписки, позвонив по указанному ниже URL-адресу API и предоставив токен доступа для этой подписки в заголовке авторизации: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint

HTTP-заголовок = авторизация:Предъявитель {токен доступа для этой подписки}

Ответ = вы синхронно получите данные для этой точки использования в течение запрошенного периода. Он будет иметь как данные об использовании интервала (), так и данные о счете ().

API синхронного использования (на что указывает структура URL-адреса, которая заканчивается идентификатором точки использования) находятся на уровне отдельной точки использования (т. е. на уровне соглашения об обслуживании), поэтому приложение будет циклически обрабатывать запросы через каждый из идентификаторов точки использования, принадлежащих данному разрешению клиента (т. е. подписке).

Ответ на синхронные запросы возвращает как интервальные данные (ниже), связанные с запрашиваемым диапазоном дат, так и любые ежемесячные итоговые значения использования и счета, которые перекрываются с запрошенным диапазоном дат (ниже ).

  • ИнтервалЧтение содержит данные об использовании электрической энергии за интервал (15 минут/час) и об использовании газа за интервал (ежедневно)
  • Сводка по использованию содержит ежемесячные итоговые значения использования и сведения о счете (если разрешено)

В ответе вы найдете элементы данных, соответствующие нашей таблице сопоставления элементов данных ESPI

Для справки, иерархическая диаграмма ниже показывает иерархию отношений для элементов данных ESPI при моделировании данных клиентов PG&E.

Ниже приведено несколько ключевых разъяснений по этим элементам данных:

  • Интервальный блок рассчитан на 1 день
  • ИнтервалЧтение (под блоком интервалов) содержит фактические значения 15-минутного/часового использования электрической энергии и ежедневные значения использования газа
  • Для потребителей электрооборудования с генерацией на объекте (например, солнечная энергия) элемент FlowDirection указывает доставленные (питание) и полученные (генерация) данные об использовании. Для клиентов с расходомерами, настроенными только на считывание чистого использования (т. е. без генерации на объекте), элемент FlowDirection указывает, что использование является чистой суммой (разница между доставленным и полученным):
    • Направление потока 1 = доставлено (энергия подается клиенту)
    • Направление потока 19 = получено (чистая генерация возвращается в PG&E-сеть). (Примечание: значения являются абсолютными)
    • Направление потока 4 = нетто (доставлено минус – получено)
  • Обратите особое внимание на мощность десяти множителей и единицу измерения (мкм), чтобы обеспечить правильное считывание показаний об использовании

Пакетная подписка (стандартная и EEF)

Вы также можете запросить данные об использовании через асинхронный API для всех Точек использования, относящихся к одному разрешению клиента на использование/выставление счетов (т. е. Подписка).

Для поддержки специальных асинхронных запросов (т. е. для более чем одной Точки использования одновременно) вашему заявлению потребуется поддержка Почтовых уведомлений, которые мы будем отправлять вам (в соответствии с URL-адресом уведомления, который вы указали во время регистрации)

Пример URL-адреса асинхронного запроса
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}?опубликовано-мин={startDate}&опубликовано-макс={endDate}

Идентификатор подписки = Идентификатор подписки, полученный в конце последовательности OAuth для получения токена доступа. Идентификатор подписки является частью параметра resourceURI в ответе маркера

published-min = дата начала, которая будет применена к этому запросу для извлечения данных. (RFC 3339 формат zulu time. гггг-ММ-ддТГ:мм:ссЗ)

опубликовано-макс. = дата окончания, которая будет применена к этому запросу для извлечения данных. (RFC 3339 формат zulu time. гггг-ММ-ддТГ:мм:ссЗ)

HTTP-заголовок = авторизация:Предъявитель {токен доступа для этой подписки}

Ответ = код состояния HTTP 202 (асинхронный запрос, при котором ответ будет размещен на URL-адресе уведомления, когда данные будут готовы)

Как только данные будут готовы, мы РАЗМЕСТИМ уведомление на предоставленный вами URI с полезными данными URL-адресов, которые ваше приложение может вернуть, чтобы получить предварительно упакованное уведомление. Образец после уведомления выглядит следующим образом:

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

Выполните GET по указанному выше URL-адресу с токеном доступа, чтобы получить данные. Он будет содержать как данные об использовании интервала (), так и информацию о счете () за запрошенный период.

Пакетная подписка (стандартная и EEF)
Вы также можете запросить информацию об использовании и выставлении счетов с помощью пакетного асинхронного API для всех ваших авторизаций клиентов для данных об использовании/выставлении счетов (т. е. Подписок).

Пример URL-адреса группового запроса
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?опубликовано-мин={startDate}&опубликовано-макс={endDate}

BulkID = BulkID, предоставленный в ресурсе ApplicationInformation Resource, полученном во время регистрационных испытаний. (BulkID=ClientID)

published-min = дата начала, которая будет применена к этому запросу для извлечения данных. (RFC 3339 формат zulu time. гггг-ММ-ддТГ:мм:ссЗ)

опубликовано-макс. = дата окончания, которая будет применена к этому запросу для извлечения данных. (RFC 3339 формат zulu time. гггг-ММ-ддТГ:мм:ссЗ)

Заголовок HTTP = Авторизация:Предъявитель {токен доступа клиента}

Ответ = код состояния HTTP 202 (асинхронный запрос, при котором ответ будет размещен на URL-адресе уведомления, когда данные будут готовы)

Как только данные будут готовы, мы РАЗМЕСТИМ уведомление на предоставленный вами URI с полезными данными URL-адресов, которые ваше приложение может вернуть, чтобы получить предварительно упакованное уведомление. Образец после уведомления выглядит следующим образом:

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

Выполните GET по указанному выше URL-адресу с токеном доступа, чтобы получить данные. Он будет содержать как данные об использовании интервала (), так и информацию о счете () за запрошенный период.

Наконец, вы можете ежедневно получать последнюю информацию об использовании и выставлении счетов, включая исправления дат в течение предыдущих периодов авторизации клиентов, используя модель ежедневной подписки (т. е. установив флажок «Уведомить меня о готовности данных (ежедневно)» во время регистрации).

Чтобы поддерживать модель ежедневной подписки, ваше приложение должно будет поддерживать Пост-уведомления, которые мы отправим вам (в соответствии с URL-адресом уведомления, который вы указали во время регистрации).

Как только данные будут готовы, мы РАЗМЕСТИМ уведомление на предоставленный вами URI с полезными данными URL-адресов, которые ваше приложение может вернуть, чтобы получить предварительно упакованное уведомление. Образец после уведомления выглядит следующим образом:

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

Выполните GET по указанному выше URL-адресу с токеном доступа, чтобы получить данные. Он будет содержать как данные об использовании интервала (), так и информацию о счете () за запрошенный период.

Ресурсы для разработчиков

Наборы для разработки программного обеспечения (SDK)

 

Чтобы помочь в разработке программного обеспечения для подключения к платформе «Поделиться моими данными», полезно увидеть подробный механизм, связанный с каждым вызовом к опубликованным конечным точкам API. С этой целью PG&E имеет несколько примеров SDK, которые она разрабатывала в прошлом для JavaScript и Python, чтобы проиллюстрировать ключевые аспекты подключения к платформе Share My Data. Эти SDK предоставляют образцы кода, которые помогут вам в процессе разработки, но не предназначены для предоставления производственного кода. Для JavaScript необходимо установить NodeJS и обязательно «npm install –save ...» для обновления соответствующих модулей библиотеки NodeJS. Код не является автономным, но содержит фрагменты, иллюстрирующие, как происходит взаимодействие между кодом клиента данных стороннего производителя и сервисами PG&E Share My Data API.

 

Чтобы помочь в реализации платформы «Поделиться моими данными», компания PG&E разработала SDK в JavasScript и Python. Эти SDK предоставляют образцы, которые помогут вам в процессе разработки, но не предназначены для предоставления функционального кода. 

Загрузить поддерживаемые API (PDF)

В документе «Поддерживаемые API» показаны API, поддерживаемые внедрением PG&E «Передача моих данных», а также URL-адрес API для PG&E.

 

Загрузить сопоставление строк области поддерживаемого функционального блока (PDF)

Документ «Сопоставление области действия поддерживаемого функционального блока» содержит подробную информацию о строке области, которая возвращается как часть ответов на запрос кода авторизации, запрос токена доступа, а также API авторизации, как описано в Обзоре сведений об авторизации . Параметр «Область» позволяет передавать окончательную область авторизации клиента. Кроме того, в этом документе указано, какие стандартные функции ESPI блокируют поддержку PG&E в реализации «Поделиться моими данными».

 

Загрузить поддерживаемую модель реляционных данных (реализация ESPI в PG&E) (PDF)

В сочетании с документом «Поддерживаемые элементы данных» модель поддерживаемых реляционных данных иллюстрирует, как взаимосвязь между различными элементами данных PG&E фиксируется стандартом ESPI.

 

Загрузить поддерживаемые элементы данных (PDF)

В документе Поддерживаемые элементы данных представлено сопоставление между элементами стандартных данных ESPI и элементами данных PG&E.

Реализация PG&E совместима с определениями схем, предоставленных ESPI, которые можно найти в GitHub. В частности, в нашей текущей реализации используются следующие версии схем:

Загрузить XSD (ZIP)
Посетить Github

 

Ознакомьтесь со следующими источниками информации о том, как завершить подпись для каждого запроса API и протестировать вызов API в соответствии с «песочницей» API GBC:

Посетите библиотеку документов с зеленой кнопкой
Посетите API зеленой кнопки

Реализация «Поделиться моими данными» соответствует национальному стандарту интерфейса поставщика энергетических услуг (ESPI). Этот стандарт также получил название Green Button Connect My Data Initiative (GBCMD), которое продвигает главный технический директор Белого дома и стипендии Президентских инноваций. В стандарте ESPI изложена техническая основа для обеспечения функциональности в отношении авторизации клиентов, обмена данными и формата авторизованных данных, которые обмениваются. Эти сведения описаны в стандартах ESPI и документации GBCMD. Документация находится в разделе «Данные зеленой кнопки» .

 

Для использования функции «Передавать мои данные» третьи лица должны сначала получить и предоставить цифровой сертификат X.509 от доверенного центра сертификации на своих серверах подключения API. Затем третьи стороны могут завершить регистрацию в PG&E на стороннем регистрационном сайте, загрузить сертификат там, получить учетные данные от PG&E, которые позволяют им проверить свое соединение, а затем получить токены на предъявителя через наши конечные точки токенов авторизации хранителя данных. Эти токены передачи описаны в стандарте OAuth2 и позволяют стороннему программному обеспечению безопасно подключать API доступа к данным PG&E. SDK предоставляет сведения о взаимодействии, как получить токены в коде сценария.

 

Токены на предъявителях доступа клиентов и токены на предъявителях доступа клиентов приобретаются отдельно и называются токенами доступа клиентов и токенами доступа соответственно. Токены доступа получаются на основании отдельного разрешения клиента PG&E. Типичный рабочий процесс — это процесс, который следует за OAuth2 в соответствии со стандартным (IETF 6749) механизмом авторизации, где клиент начинает работу на стороннем объекте, и этот сайт сначала перенаправляет клиента на сайт https://sharemydata.pge.com/#MyAuthorization/ для аутентификации. Там клиент проходит аутентификацию в PG&E и проходит через область действия, определяющую авторизацию доступа к данным третьей стороны («Процесс перехода»). После завершения PG&E перенаправляет ответ HTTP 302 третьей стороне, после чего третья сторона готова получить токены на предъявителя (токен доступа). Рассмотрите подробный процесс (PDF, 463 КБ).

 

Сторонний клиентский сервер данных подключается к конечным точкам API доступа к данным PG&E через взаимное соединение TLS 1.2. Доступ к отдельным конечным точкам API, управляемым токенами канала; после принятия и обработки запроса данные возвращаются в синхронном ответе или асинхронном ответе на основе уведомления по указанному третьей стороной URL-адресу.

 

Данные соответствуют вышеупомянутой схеме ESPI. Просмотрите описание поддерживаемых элементов (PDF, 283 КБ).

 

PG&E выпускает данные в соответствии с объемом, разрешенным для типа третьей стороны и разрешения клиента.

 

Просмотрите определение области (XLSX ), а также следуйте определениям области зеленой кнопки .

 

Перед регистрацией для использования функции «Поделиться моими данными» мы настоятельно рекомендуем вам и вашей организации ознакомиться со следующими ресурсами:

 

Посетите SDK данных зеленой кнопки
Инструменты для создания, тестирования и отображения файлов данных с зеленой кнопкой. Найдите SDK, разработанные PG&E: JavaScript (ZIP, 1,7 МБ)| Python (ZIP, 5 КБ)

 

Посетите «Песочницу API с зеленой кнопкой»
Этот API-песочница предоставляет разработчикам полный доступ в формате зеленой кнопки к информации об использовании энергии с целью разработки новых приложений зеленой кнопки.

Из-за ограниченных системных ресурсов, а также для того, чтобы позволить PG&E снизить операционные риски, для обеспечения постоянной стабильности платформы для наших пользователей действуют следующие пороговые пределы API.

  • Один запрос в секунду на поставщика по всем идентификаторам клиентов поставщика
  • 2000 вызовов API в час на каждый идентификатор клиента
  • 20 000 вызовов API за 24-часовой период на идентификатор клиента. Ежедневные пороговые значения сбрасываются в 17:00. ПТ

Обратите внимание, что условия допустимого использования могут быть изменены. Команда «Поделиться моими данными» постоянно оценивает нашу способность поддерживать запросы третьих лиц по мере роста платформы и интеграции с системой большего числа пользователей. Тем не менее, мы обязательно сообщим о таких изменениях до их внедрения.

Для получения информации об улучшениях и изменениях, внесенных в раздел «Передача моих данных», см. следующие примечания к выпуску. Если вы столкнулись с проблемой с передачей моих данных или у вас есть предложение улучшить обслуживание, свяжитесь с нами по адресу ShareMyData@pge.com.

20 июня 2024 г.

 

PG&E Share My Data Platform (SMD) для авторизованного клиентом обмена данными со сторонними поставщиками услуг выпустила 2-й этап улучшения идентификатора измерителя, что позволяет идентифицировать отдельный идентификатор измерителя, связанный с данными измерителя электрических интервалов.  

Это усовершенствование особенно полезно для пользовательских сценариев, когда несколько счетчиков связаны с одним соглашением об обслуживании.

 

Фаза 1:  Выпущено в марте 2023 г. — Изменены затронутые API, чтобы начать добавление значения вместе со значением в возвращаемом ответе под тегом . Между значением серийного номера и значением utcNumber существует согласование один на один.

Эта информация позволяет поставщикам, использующим эти API, создавать хранилище записей с utcNumber вместе со значением серийного номера, связанным с данным расходомером для их клиентской базы, до выпуска расширения фазы 2.

 

Фаза 2: Выпущено 20 июня 2024 г. — заменяет значения MeterReadingID из текущего формата encode64 описательных значений счетчика на utcNumber. После того как эти изменения будут полностью реализованы, пользователи Share My Data получат улучшенную возможность привязываться к конкретному использованию счетчиков с интервалом, в случаях, когда несколько метров одного и того же товара связаны с одним соглашением об обслуживании на стороне потребителя, к конкретному идентификатору счетчика, который создал использование. 

 

Изменения фазы 2 влияют на следующие АФИ

Затронутый 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}

Все остальные API с интервальными показаниями остаются неизменными и представляют СУММУ интервалов расходомеров в обоих направлениях потока и со всеми расходомерами в соответствии с договором об обслуживании.

Перед выпуском поле MeterReadingID было закодировано как Base64, и возвращаемое значение отображается следующим образом:

MeterReadingID= TnpJNmJuVnNiRG96TmpBd09qRT06MTox

Расшифровано из формата Base64 следующим образом:  NzI6bnVsbDozNjAwOjE =:1:1

Отображается показаниеTypeID:rownum:count, и значение readingTypeID снова декодируется из Base64 как:

72:null:3600:1, где значения:uom:фаза:интервалДлина:flowDir

UOM = 72, фаза = ноль, интервалДлина = 3600 и потокДир = 1 (доставлено)

В фазе 2 поле MeterReadingID добавляется с дополнительными символами, и после первоначального декодирования будут получены следующие примеры результатов

MeterReadingID=TnpJNmJuVnNiRG96TmpBd09qRT06MToxOjQ0MTEzMTA1NDYgICAgICAgICAg

Один раз декодировано с Base64:  NzI6bnVsbDozNjAwOjE =:1:1:4411310546, 

Это показывает, что meter_UUID 4411310546, и это значение должно соответствовать значению , доступному в API RetailCustomer под тегом .

Значение «NzI6bnVsbDozNjAwOjE=:1:1:» — это readingTypeID:rownum:count, т. е. номер строки равен 1, а число равно 1, что связано с записями внутренней базы данных PG&E. Значение readingTypeID снова декодируется следующим образом:

72:null:3600:1, где значения:uom:фаза:интервалДлина:flowDir

UOM = 72, фаза = ноль, интервалДлина = 3600 и потокДир = 1 (доставлено)

 

Это изменение позволяет пользователям указать физический расходомер и направление потока, представляющее интерес, в показаниях интервала. Обратите внимание, что все файлы XML теперь будут иметь новые значения MeterReadingID и будут применять новую форму кодирования фазы 2. «Поделиться моими данными» рекомендует всем поставщикам, использующим любой вызов API с помощью MeterReadingID, выполнить следующий вызов API, чтобы получить новый MeterReadingID: .../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading

20 марта 2023 г.

 

Что нового:

 

  1. Выпуск нового кода ответа API HTTP (204) как для синхронных, так и для асинхронных вызовов API, чтобы указать, когда данные для запрашиваемого диапазона недоступны.
  2. Поддержка метки заголовка x-транзакции, которая поддерживает возможность связывания ответа PG&E с конкретными асинхронными вызовами API путем возврата этого значения вместе с идентификатором корреляции, когда запрошенный файл будет готов.
  3. Улучшенная детализация дополнительных данных для UsagePoint/MeterReadingID API за счет предоставления данных электрических интервалов для нескольких метров в один сценарий соглашения об обслуживании.
  4. Добавлена дополнительная ясность в значения индикатора качества считывания для РАСЧЕТНЫХ данных за интервал, чтобы описать тип оценки, используемой для этого интервала. Новые значения, указывающие на применение оценочной логики, приведены ниже:

  5. Значение и описание RQI

    0 - Действительны: данные, прошедшие все необходимые проверки и либо прошедшие все, либо проверенные

    7 - Отредактировано вручную: заменено или одобрено человеком

    8 - Рассчитано с использованием эталонного дня: значение данных было заменено рассчитанным машиной значением на основе анализа исторических данных с использованием того же типа измерения

    9 - Рассчитано с использованием линейной интерполяции: значение данных было рассчитано с использованием линейной интерполяции на основе показаний до и после нее

    10 - Сомнительные: данные, которые не прошли одну или несколько проверок

    11 - Производные: данные, которые были рассчитаны (с использованием логических или математических операций), не обязательно измерены напрямую

    12 - Прогнозируемые (прогнозные): данные, которые были рассчитаны как прогноз или прогноз будущих показаний

    13 - Смешанный: указывает на то, что качество этого показания имеет смешанные характеристики

    14 - Необработанные данные: данные, которые не прошли процесс проверки, редактирования и оценки. ПРИМЕЧАНИЕ Индикатор RQI расходомеров MV90 останется в 14 состоянии окончательного RQ

    15 - Нормализовано погоде: значения скорректированы с учетом погоды, для сравнения использования в различных климатических условиях

    16 - Другое: указывает на то, что характеристика применима к характеристикам, отличным от определенных

    17 - Валидированные: данные, которые были валидированы и, возможно, отредактированы и/или оценены в соответствии с утвержденными процедурами

    18 - Проверено: данные, которые не прошли хотя бы одну из требуемых проверок валидации, но были определены как фактические

    19 - Качество дохода: допустимо и приемлемо для выставления счетов [возможное продление стандарта ESPI, а не часть оригинального стандарта ESPI]

     

  6. Выпуск метрик использования API поставщика на портале для поставщиков «Передача моих данных третьим лицам».

15 ноября 2018 г.

 

Что нового:

 

  1. Добавлен индикатор класса клиента. Каждое утвержденное SAID будет обозначено как RES, AGR, COM/IND или другое.
  2. API для выставления счетов и использования будут обновлены для принятия параметров запроса с обновленным максимумом и обновленным минимумом (в качестве альтернативы опубликованному минимуму и опубликованному максимуму). Возвращенные данные будут представлять собой все изменения, которые произошли в пределах обновленных максимальных и обновленных минимальных параметров.
  3. Замена использования 5-значного массового идентификатора третьей стороны идентификатором клиента третьей стороны для процесса онлайн-авторизации.
  4. Предоставление третьей стороне возможности перенаправлять клиентов на вход в учетную запись PG&E или на вкладку «Гостевой доступ» в рамках процесса онлайн-авторизации.
  5. Улучшение информационной панели PG&E для клиентов Share My Data, чтобы клиентам было проще просматривать все свои существующие разрешения на обмен данными с третьими сторонами.

27 сентября 2018 г.

 

Что нового:

 

PG&E добавила новые элементы данных в набор данных правила 24 в рамках проекта расширенного набора данных (EDS) PG&E, и соответствующие новые элементы данных вводятся в набор данных правила 25. Конкретные элементы данных, входящие в расширенный набор данных правила 25 PG&E, изложены ниже с обозначением EDS:

 

Элементы данных правила 25

 

Примечания
Элементы учетной записи
Название учетной записи
Адрес учетной записи
Идентификатор учетной записи
ЭЦП: Блок отключения
Элементы обслуживания
UUID PG&E
Идентификатор службы
Будущие изменения в статусе обслуживания
Статус SA
Дата начала обслуживания
Адрес службы
Текущий тариф на обслуживание
Исторический тариф на услуги по выставлению счетов
Варианты тарифов (Medical Baseline, CARE, FERA, TBS, CCA_TBS, Solar Choice
Текущее рабочее напряжение и историческое выставленное рабочее напряжение товара
Номер счетчика услуг
Количество счетчиков обслуживания
Тип измерительного прибора
Текущий цикл считывания показаний измерителя
Цикл считывания хронологического биллингового счетчика
Опция текущей скорости режима ожидания, если индикатор генерации на месте
Опция исторического тарифа для выставления счетов в режиме ожидания
EDS: индикатор класса клиента
Элементы исторического выставления счетов
Дата начала выставления счета
Дата окончания выставления счета
Выставить счет за общую сумму расходов($)
Общая сумма счета кВт·ч
EDS: наименование поставщика услуг
Разбивка по историческому уровню счета (при наличии)
EDS: Период выставления счета за позицию
EDS: Название (по сравнению с исходным уровнем 1–30%)
EDS: Объем (1234.2)
EDS: Скорость (0,032 долл. США/кВт·ч)
EDS: Стоимость (100,23 долл. США)
Разбивка исторического билля TOU кВт·ч (за исключением счета ABS-TX)
EDS: Период выставления счета за позиции (для разбивки TOU)
ЭЦП: наименование (затраты на обслуживание)
EDS: Объем (1234.2)
EDS: Скорость (0,032 долл. США/кВт·ч)
EDS: Стоимость (100,23 долл. США)
Разбивка спроса на исторические счета
EDS: Период выставления счета за позицию (для разбивки спроса)
EDS: Имя
EDS: Объем (1234.2)
EDS: Скорость (0,032 долл. США/кВт·ч)
EDS: Стоимость (100,23 долл. США)
Элементы строки хронологического счета
EDS: Период выставления счета за позицию
EDS: Наименование платежа (DWR Bond Charge)
EDS: Объем (1234.2)
EDS: Единица измерения (кВт·ч)
EDS: Скорость (0,032 долл. США/кВт·ч)
EDS: Стоимость (100,23 долл. США)
Исторические интервалы использования
Начало использования интервала
Длительность интервала по умолчанию (в секундах)
Объем использования интервала (1234.2)
Единица измерения (кВт·ч/термс)
Программы реагирования на спрос на коммунальные услуги
(DR) Название программы
Самая ранняя дата увольнения без финансовых обязательств
Самая ранняя дата увольнения, независимо от финансовых обязательств
Состояние программы DR
Дата включения в программу DR
Дата прекращения участия в программе DR
Элементы данных
Товар
Параметры местного времени (подробности DST)
Качество данных по умолчанию
Направление энергии
Коэффициент мощности десяти (для значений использования интервала)
Множитель «Сила десяти» (для выставленного спроса)
Множитель мощности десяти (для общего количества использований по выставленным счетам)
Длительность интервала(показания использования)
Валюта общей стоимости счета
Индикаторы TOU электрического интервала

28 июня 2018 г.

 

В рамках проекта Click-Chrough и постоянного улучшения платформы Share My Data Platform PG&E запустила этап Click-Chrough 2 28 июня 2018 года.

 

Что нового:

 

Наиболее важными изменениями, которые влияют на третьи стороны, являются изменения для соответствия протоколу OAuth 2.0 (PG&E устранила первоначальную серию перенаправлений). Ниже приведена подробная информация.

 

ВАЖНО: Третьи стороны ОБЯЗАНЫ вносить изменения в существующую реализацию OAuth. Изменения PG&E фазы 2 НЕ являются обратно совместимыми, поэтому третьим сторонам необходимо внедрять изменения одновременно с внедрением PG&E. Без реализации текущий процесс авторизации клиентапрекратит работу по состоянию на дату прекращения сбора данных 29 июня 2018 г. Однако существующие разрешения не затрагиваются.

  1. Для соответствия протоколу OAuth 2.0 PG&E сократила количество шагов перенаправления для авторизации. Первоначальное перенаправление клиентов в PG&E для входа в систему и отправки авторизации было объединено с запросом кода авторизации следующим образом:
    • Как показано в примере ниже, запросы сторонних авторизационных кодов теперь включают перенаправление браузера клиента на новый authorizationServerAuthorizationEndpoint&E вместе с соответствующими параметрами запроса:
      ПОЛУЧИТЕ https://sharemydata.pge.com/myAuthorization?client_id=xxxxx&redirect_uri={redirect_uri}&response_type=code&state={optionalState}
    • Следующая конечная точка была выведена из обращения: https://api.pge.com/datacustodian/oauth/v2/authorize...
  2. Новые сообщения об обработке ошибок для запросов авторизационного кода с отсутствующими или недействительными параметрами области действия:
    • Если требуемые параметры Client_id или redirect_uri отсутствуют или недействительны, клиенту отображается ошибка (http 400) с пояснительным сообщением
    • Если требуемый параметр response_type отсутствует или недействителен, клиент будет перенаправлен обратно к redirect_uri третьей стороны с параметром ошибки «invalid_request» (прилагается к redirect_uri)
  3. Для клиентов с существующей онлайн-авторизацией возможность для третьей стороны запросить новую пару access_token/refresh_token в рамках новой авторизации, которая заменяет существующую (т. е. онлайн-авторизация той же третьей стороны и комбинации клиентов). Эта функция касается сценариев потери пар токен доступа/обновления токена третьими лицами или иной необходимости изменения объема первоначального разрешения на утверждение клиентом.
    • Для запросов на повторную авторизацию клиент видит новую страницу авторизации вместо страницы «управлять авторизацией» при перенаправлении третьей стороной в PG&E для авторизации
    • После авторизации клиента третьи лица получают уведомление на свой зарегистрированный URL-адрес с уведомлением о том, что старый ID подписки отменен (уведомление включает конечную точку API авторизации для старого ID подписки)
  4. Возможность для клиента выйти с помощью кнопки «отмена» на странице аутентификации или на странице авторизации с перенаправлением обратно к переадресации_uri третьей стороны с параметром ошибки «access_denied» (прилагается к переадресации_uri)
  5. Для третьих сторон, которые регистрируются с настройками «видимость» и поэтому включены в список зарегистрированных третьих сторон, клиенты увидят, когда они перейдут на свою учетную запись PG&E в Интернете и перейдут на целевую страницу «Поделиться моими данными»:
    • Для клиентов, которые вошли в свою учетную запись PG&E в Интернете и переходят на целевую страницу «Поделиться моими данными», а затем перенаправляются на зарегистрированный URI портала третьей стороны после выбора третьей стороны из списка зарегистрированных третьих сторон. На этом этапе клиенты могут приступить к процессу OAuth, инициированному третьей стороной. При прохождении этого пути клиентам больше не будет отображаться страница авторизации при выборе третьей стороны из выпадающего списка третьих сторон, а вместо этого они будут перенаправлены на зарегистрированный URI портала третьей стороны, где они могут начать процесс OAuth, инициированный третьей стороной
    • Примечание. Некоторые третьи стороны спросили, как оптимизировать взаимодействие с клиентами для этого сценария использования (т. е. авторизации, инициированные на сайте PG&E), чтобы клиент мог видеть, что они переходят непосредственно на страницу авторизации при выборе третьей стороны из выпадающего списка. Для облегчения такого взаимодействия с клиентом третьи стороны могут выбрать параметр «URI стороннего портала» (через страницу регистрации управления разделом «Передача моих данных») для оконечного устройства, которое автоматически перенаправляет клиента обратно в PG&E в рамках запроса на авторизационный код. После автоматического перенаправления обратно на authorizationServerAuthorizationEndpoint клиент пропустит страницу входа клиента (поскольку он уже вошел в систему) и перейдет непосредственно на страницу авторизации. Для некоторых третьих лиц, которые зарегистрировались до выпуска «Поделиться моими данными Нажмите через 2.0», это можно сделать, просто задав URI портала для третьих лиц, чтобы он был равен больше не используемому URI «Экрану выбора области действия третьей стороны» (старое поле регистрации SMD будет выведено из обращения в будущем).
      В отличие от этого, некоторые третьи стороны могут захотеть сначала привлечь и проверить клиентов со своей стороны, когда клиенты перенаправляются на свой URI «Портала третьих сторон» перед запросом авторизационного кода, поэтому вышеуказанный подход является лишь предложением.
  6. Теперь SMD предоставит расширенные данные параметров области действия в рамках ответов на запрос кода авторизации, запрос токена доступа и API авторизации. Параметр расширенной области действия позволяет передавать окончательный объем авторизации клиента. В частности, параметр области включает значение «Дополнительный объем», которое отображается в поддерживаемых PG&E вариантах авторизации клиентов групп данных (например, «Использование», «Выставление счетов», «Базовый», «Учетная запись», «Регистрация программы»). Значения параметров осциллографа дополнительно фиксируются в соответствии со следующей документацией:Скачать сопоставление строк осциллографа поддерживаемого функционального блока Click Thru 2.0 (PDF)

    Пример ответа маркера ниже иллюстрирует некоторые возможные значения параметров области.
    • Пример ответа токена:
      <Ответ xmlns="https://api.pge.com/datacustodian/oauth/v2/token">
      774ff105-7ad5-40c8-a6ec-f60675dc0e41
      3600
      998c6654-5b3b-4385-af4f-4e5c46c1bb04
      scope=FB=1_3_8_13_14_18_19_31_32_35_37_38_39_40_4_5_10_15_16_46_47; AdditionalScope=Usage_Billing_Basic_Account_ProgramEnrollment;IntervalDuration=900_3600;BlockDuration=Daily;HistoryLength={3P Registered Historical length};AccountColle Collection={count of authorized SAs};BR={ThirdPartyID};dataCustodianId=PGE
      ресурсURI:{ResourceURI}, например: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{subscriptionID}
      URI авторизации:{AuthorizationURI}, например: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{authorizationID}
      CustomerResourceURI:{customerResourceURI}, например:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
      Несущий


  7. Теперь третьи лица могут зарегистрироваться для получения информации о регистрации в программе через новую группу данных «Регистрация в программе». Как измерительные интервалы, так и клиенты с измерительными интервалами, не имеющие отношения к интервалам, будут иметь право на разрешение на передачу данных для фазы 2 с переходом по SMD. Ниже представлен общий обзор новых доступных элементов данных, предоставленных группой данных о регистрации в программе:
    • Регистрация в программе (название/статус программы PG&E Demand Response и информация CAISO):
    • (Выставление счетов) Адрес счета
    • Статус договора об оказании услуг
    • (Текущий) тариф на обслуживание
    • (Ток) Рабочее напряжение (только электрическое)
    • Номер сервисного счетчика (при наличии)
    • Тип измерительного прибора
    • (Текущий) цикл считывания счетчика
    • (Текущий) вариант коэффициента ожидания, если индикатор генерации на месте
    • (использование интервала по умолчанию) Длительность (длительность в секундах)
    • (Реагирование на запросы PG&E) Название программы (если применимо)
    • Самая ранняя дата прекращения участия в программе реагирования на спрос (DR) PG&E без финансовых обязательств
    • Самая ранняя дата увольнения из зарегистрированной в PG&E программы реагирования на спрос (DR) независимо от финансовых обязательств
    • Статус программы PG&E Demand Response (DR) (регистрация)
    • Дата регистрации в программе PG&E Demand Response (DR)
    • Дата прекращения участия в программе PG&E Demand Response (DR)
    • Сопоставление Atom XML XSD (определение схемы XML) для этих новых элементов данных фиксируется в соответствии со следующей документацией:
      Загрузить поддерживаемые элементы данных (PDF)
    • Модель иерархии связанных реляционных данных изложена следующим образом:
      Загрузить модель данных PGE ESPI (PDF)
    • UsagePoint (также известный как SA UUID)
      • ServiceDeliveryPoint\tariffProfile(текущий тарифный план AKA, включая опцию тарифа ожидания, если применимо)
      • readCycle (текущий цикл чтения измерителя)Обзор использования
      • readCycle (цикл обслуживания выставления счетов)
      • Товар (включает уровень напряжения для электрического оборудования)
      • тарифный профиль (тариф на услуги по выставлению счета, включая опцию «Тариф ожидания», если применимо
    • Тип считывания
      • Товар (включает уровень напряжения тока для электрического оборудования и префикс для опции нормы резервирования, если применимо)
    • Учетная запись клиента
      • (Адрес выставления счета):
      • mainАдрес/улицаПодробная информация...
      • mainАдрес/городПодробная информация...
      • основнойАдрес/почтовыйкод...
    • Соглашение с клиентом
      • состояние\значение (статус SA
    • Программа реагирования на спрос
      • Название программы
      • статус включения в исследование
      • Дата/дата программы
      • ПрограммаДата/программаДатаОписание
    • Счетчик
      • серийный номер (идентификатор счетчика)
      • тип (тип расходомера)
      • (текущий) интервалДлина
    • Последние определения схемы ESPI xml (XSD), используемые для этих новых элементов данных, изложены следующим образом:
      Загрузить XSD (ZIP)
      Примечание: XSD обратно совместимы.
    • Третьи стороны будут иметь возможность изменить свою регистрацию, чтобы позволить клиентам выбирать эту группу данных во время авторизации через портал третьей стороны в разделе «Управление регистрацией» > «Редактировать» > «Раздел»: Укажите необходимую информацию о клиенте", установите флажок Регистрация в программе.
    • Примечание:это относится только к новым авторизации клиентов.
    • Новые API для получения информации о регистрации DR доступны на уровне Пакета 3-й стороны, а также на уровне авторизации отдельного клиента (уровень RetailCustomerID), как указано ниже:
      Загрузить новые API, поддерживаемые PGE (PDF)
    • Асинхронный API для запроса информации о регистрации DR для всех авторизаций третьей стороне
      • https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailDRPrgInfo/{BulkID}
    • Синхронный API для запроса информации о регистрации DR на уровне авторизации отдельного клиента
      • https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailDRPrgInfo/{RetailCustomerID}

 

Обратите внимание: Помимо изменений в процессе авторизации клиентов, другие изменения также являются обратно совместимыми и являются добровольными улучшениями, которые третьи стороны могут выбрать для поддержки.

 

Если у вас есть какие-либо вопросы или вам нужна дополнительная поддержка, обращайтесь по адресу электронной почтыsharemydata@pge.com.

Что нового:

 

  1. Теперь клиенты могут воспользоваться преимуществами оптимизированного процесса авторизации Click-Chrough.
    • Мы обновили информацию о том, как клиент может теперь обмениваться данными с вашей компанией.
      Узнайте, как клиенты обмениваются данными с компанией

      Примечание:
      Эти изменения, особенно улучшения нашего пользовательского интерфейса авторизации, были оптимизированы для мобильных устройств (например, телефонов или планшетов).
    • Внесены изменения в процесс управления авторизацией, доступный клиентам через их онлайн-аккаунт PG&E:
      • Клиент может удалить SAID из существующей авторизации, продлить дату окончания авторизации и/или отменить авторизацию в любое время. Однако для добавления дополнительных SAID и/или изменения элементов авторизованных данных необходимо отменить существующее разрешение и создать новое разрешение.
  2. При желании третьи лица могут использовать этот API для отзыва индивидуальных авторизаций клиентов с использованием своего токена доступа клиента третьей стороны (предоставленного во время первоначального процесса регистрации третьей стороны в SMD) посредством операции УДАЛИТЬ: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{AuthorizationID}

    Примечание 1:Для реализации PG&E параметр AuthorizationID является тем же значением, что и SubscriptionID.

    Примечание 2:Новый API предоставляет третьим сторонам возможность отозвать (отменить) авторизацию. Однако только клиенты могут удалять идентификаторы SA и/или обновлять дату окончания авторизации на наших страницах авторизации управления SMD.

    Напоминание:Как и в случае со всеми запросами данных API, третьи лица должны сначала запросить новую пару токенов (доступ клиента + обновление токена), используя свои последние обновления токенов.

    Напоминание о сроках действия токена:
    • Токен доступа:1 час
    • Токен доступа клиента: 5 мин
    • Соответствующие маркеры обновления: 1Yr
  3. Теперь третьи лица могут создать несколько регистраций Share My Data (SMD), используя одно и то же название компании и налоговый идентификатор, если это необходимо. Однако отображаемое имя (которое клиенты видят при авторизации) должно быть уникальным.

    Примечание:Все указанные выше изменения являются обратно совместимыми и являются добровольными улучшениями, которые третьи стороны могут принять для поддержки. Скачать сопроводительные документы для этого выпуска:

    SUPPORTED_APIS.SMD_CLICK-THRU_1.0 (PDF)

    ПОДДЕРЖИВАЕМЫЕ_ДАННЫЕ_ЭЛЕМЕНТЫ_RETAILCUSTOMER.SMD_CLICK_THRU_1.0 (PDF)

    PGE_ESPI_DATA_MODEL.SMD_CLICK-THRU_1.0 (PDF)

    ПОДДЕРЖИВАЕМЫЕ_ДАННЫЕ_ЭЛЕМЕНТЫ_ESPIDERIVED.SMD_CLICK_THRU_1.0 (PDF)

    ESPI_XSDS (ZIP)

20 декабря 2015 г.

 

Требуемые изменения:следующие обновления SMD 2.0 требуют изменений со стороны третьих сторон.

  1. Принимая во внимание третьи стороны, использующие GBCMD (Green Button Connect My Data) на нескольких коммунальных предприятиях, кроме PG&E, мы передадим обратно идентификатор DataCustodianID (т. е. dataCustodianID=PGE) в перенаправлении на портал ThirdPartyScopeSelectionScreenURI во время последовательности авторизации OAuth.
  2. Запросы API, которые принимают параметры даты (например, пакетный запрос), должны использовать параметры данных Zulu (например, опубликованные-макс/опубликованные-мин). Другие форматы дат для параметров дат в запросах API не поддерживаются.
    • API, которые принимают параметры даты, документируются в соответствии с прилагаемым файломSupported APIs.xlsx
  3. Индикаторы TOU за интервал, включенные в данные об использовании электроэнергии за интервал (если применимо, индикатор того, какой период TOU соответствует каждому интервалу)
    • См. статические схемы идентификаторов программ, в которых указано, к чему относится каждый интервал подсчета TOU (например, 1 = летний пик и т. д.). (См. приложение,Supported Data Elements.xlsx )
  4. Идентификатор клиента, найденный в данныхCustodianScopeSelectionScreenURI (используется для OAuth, инициированного третьей стороной) и предоставленный в запросе ресурса информации о приложении третьих сторон во время регистрационных испытаний, обновляется до 5 цифр, если он еще не обновлен (например, добавление начальных нулей и т. д.). Кроме того, URL-адрес больше не содержит '&verified=true' в конце. Третьим сторонам потребуется соответствующим образом обновить свои URL-адреса.
    • Для более подробной информации, dataCustodianScopeSelectionScreenURI выглядит следующим образом: https://sharemydataqa.pge.com/myAuthorization/?clientId=XXXX (XXXX — это идентификатор клиента)
    • Таким образом, текущий идентификатор клиента 123 изменится на 00123, что означает, что его новые данныеCustodianScopeSelectionScreenURI будут выглядеть следующим образом:
      https://sharemydataqa.pge.com/myAuthorization/?clientId=00123 (старый URL-адрес: https://sharemydataqa.pge.com/myAuthorization/?clientId=00123&verified=true)
  5. Третьи стороны, зарегистрированные как «ESP» или «Поставщик энергетических услуг», изменяют свой статус на «Стандартный тип пользователя». Функциональные изменения отсутствуют, только в заголовке типа пользователя. Отличие типа пользователя ESP (от стандартного типа пользователя) является ненужной дифференциацией, вызывающей путаницу во время процесса регистрации без предоставления каких-либо дифференцированных функций, поэтому он выводится из обращения.

Дополнительные улучшения: Следующие изменения являются обратно совместимыми и являются добровольными улучшениями, которые третьи стороны могут принять для поддержки.

  1. Третьи стороны будут иметь возможность автоматически изменять/обновлять свои сертификаты SSL, которые они изначально предоставили во время регистрации (например, когда срок действия сертификата истекает) через портал третьей стороны под управлением регистрации >Редактировать > новый раздел: Информация о сертификате SSL (вариант обновления).
  2. Третьи лица могут зарегистрироваться для получения утвержденной базовой платежной информации, информации о клиенте и данных о газе.  Как измерительные, так и неинтервалные измерительные клиенты будут иметь право разрешать обмен данными для SMD 2.0. Ниже представлен общий обзор новых доступных элементов данных:
    • Информация для выставления счетов: (для АБ, измеренных как за интервал, так и за неинтервал)
      • Тарифный график, итоговые суммы в долларах США для выставления счетов, многоуровневое использование (если применимо), спрос (если применимо), итоговые суммы TOU (если применимо)
      • Примечание.Для авторизованных клиентов с неинтервалным измерением третьи лица будут получать только итоговые суммы использования счетов (т. е. в Сводке по использованию) и не будут читать данные об использовании интервалов (т. е. почасовые/ежедневные показания, поскольку они недоступны)
    • Информация о клиенте: (для АБ с измерением интервалов и без них)
      • Имя клиента, адрес службы, идентификатор учетной записи, идентификатор соглашения об обслуживании, дата начала обслуживания по соглашению об обслуживании,
    • Данные об использовании газа за период: (только SA с счетчиком за период)
      • Интервальные (т. е. ежедневные) показания газа
    • Новые элементы данных представлены на диаграммах в соответствии с прилагаемым файлом,Supported Data Elements.xlsx
    • Связанная иерархия реляционных данных описана в прилагаемом файле PGE ESPI Data Model.xlsx
    • Последние определения схемы ESPI xml (XSD), используемые для этих новых элементов данных, соответствуют прилагаемым XSD. Примечание: XSD обратно совместимы:
      • espiDerived.xsd (информация об использовании интервалов и выставлении счетов)
      • retailcustomer.xsd (информация о клиенте)

Если у вас есть какие-либо вопросы или вам нужна дополнительная поддержка, свяжитесь с нами по адресу ShareMyData@pge.com.

18 декабря 2015 г.
 

Требуемые изменения: следующие обновления SMD 2.0требуют изменений со стороны пользователей, имеющих доступ к собственным данным:

  1. Запросы API, которые принимают параметры даты (например, пакетный запрос), должны использовать параметры данных Zulu (например, опубликованные-макс/опубликованные-мин). Другие форматы дат для параметров дат в запросах API не поддерживаются.
    • API, которые принимают параметры даты, документируются в соответствии с прилагаемым файломSupported APIs.xlsx
  2. Индикаторы времени использования интервала (TOU), включенные в данные об использовании электроэнергии за период (если применимо, индикатор того, какой период TOU соответствует каждому интервалу)
    • См. статические схемы идентификаторов программ, описывающие, к чему относится каждый интервал подсчета TOU (например, 1 = летний пик и т. д.). (См. приложение,Supported Data Elements.xlsx )

Дополнительные улучшения: Следующие изменения являются обратно совместимыми и являются добровольными улучшениями, которые третьи стороны могут решить поддержать.

  1. Пользователи с самостоятельным доступом будут иметь возможность автоматически изменять/обновлять свои сертификаты SSL, которые они изначально предоставили во время регистрации (например, когда срок действия сертификата истекает) через сторонний портал под управлением регистрации > Редактировать > новый раздел: Информация о сертификате SSL (вариант обновления)
  2. Регистрация пользователей с самостоятельным доступом будет обновлена с целью включения утвержденной базовой платежной информации, информации о клиенте и данных о газе. Оба соглашения об обслуживании с измерением интервала, как и соглашения об обслуживании без измерения интервала, будут иметь право на (самостоятельное) авторизацию для SMD 2.0. Краткий обзор новых доступных элементов данных на высоком уровне выглядит следующим образом:
    • Информация для выставления счетов: (для АБ, измеренных как за интервал, так и за неинтервал)
      • Тарифный график, итоговые суммы в долларах США для выставления счетов, многоуровневое использование (если применимо), спрос (если применимо), итоговые суммы TOU (если применимо)
      • Примечание.Для авторизованных клиентов с неинтервалным измерением третьи стороны будут получать только итоговые суммы использования счетов (т. е. в Сводке использования) и не будут читать показания об использовании интервалов (например, почасовые/ежедневные показания, поскольку они недоступны)
    • Информация о клиенте: (для АБ с измерением как за интервал, так и без него)
      • Имя клиента, адрес службы, идентификатор учетной записи, идентификатор соглашения об обслуживании, дата начала обслуживания по соглашению об обслуживании,
    • Данные об использовании газа за период: (только SA с счетчиком за период)
      • Интервальные (т. е. ежедневные) показания газа
    • Новые элементы данных представлены на диаграммах в соответствии с прилагаемым файлом,Supported Data Elements.xlsx
    • Связанная иерархия реляционных данных описана в прилагаемом файле PGE ESPI Data Model.xlsx
    • Последние определения схемы ESPI xml (XSD), используемые для этих новых элементов данных, соответствуют прилагаемым XSD. Примечание: XSD обратно совместимы:
      • espiDerived.xsd (информация об использовании интервалов и выставлении счетов)
      • retailcustomer.xsd (информация о клиенте)

Если у вас есть какие-либо вопросы или вам нужна дополнительная поддержка, свяжитесь с нами по адресу ShareMyData@pge.com.

18 декабря 2015 г.
 

Требуемые изменения: следующие обновления SMD 2.0требуют изменений со стороны внедрения CCA.

  1. Специальные запросы (например, для исторических данных) должны выполняться с использованием параметров даты времени Zulu. Другие форматы даты для параметров даты в запросах API не поддерживаются.
  2. Ежедневная лента массового использования начнет включать базовую платежную информацию, а ежедневная лента массового использования будет включать дополнительную информацию о клиенте. Эти новые данные будут предоставлены как для клиентов с интервальным замером, для которых они получают данные в настоящее время, так и для клиентов без интервального замера на их территории, для которых они в настоящее время не получают данные. Наконец, значения использования интервала, указанные в ежедневной ленте массового использования, будут включать индикаторы TOU интервала, если это применимо. Краткий обзор новых элементов данных на высоком уровне:
    • Информация для выставления счетов: (для АБ, измеренных как за интервал, так и за неинтервал)
      • Тарифный график, итоговые суммы в долларах США для выставления счетов, многоуровневое использование (если применимо), спрос (если применимо), итоговые суммы TOU (если применимо)
    • (Дополнительно) Информация о клиенте: (для АБ с измерением интервала и без него)
      • Имя клиента, адрес обслуживания, дата начала обслуживания по соглашению об обслуживании, идентификатор учетной записи
    • Индикаторы TOU за интервал, включенные в данные об использовании электроэнергии за интервал (если применимо, индикатор того, к какому периоду TOU относится каждый интервал)
      • См. статические схемы идентификаторов программ, описывающие, к чему относится каждый интервал подсчета TOU (например, 1 = летний пик и т. д.). (См. приложение,Supported Data Elements.xlsx )
    • Последние определения схемы ESPI xml (XSD), используемые для этих новых элементов данных, соответствуют прилагаемым XSD. Обратите внимание, что XSD обратно совместимы:
      • espiDerived.xsd (информация об использовании интервалов и выставлении счетов)
      • retailcustomer.xsd (Информация о клиенте)
    • Новые элементы данных представлены на диаграммах в соответствии с прилагаемым файлом,Supported Data Elements.xlsx
    • Связанная иерархия реляционных данных описана в прилагаемом файле PGE ESPI Data Model.xlsx

Дополнительные улучшения: Следующие изменения являются обратно совместимыми и являются добровольными улучшениями, которые третьи стороны могут решить поддержать.

  1. CCA могут делать специальные запросы на информацию о клиенте по адресу: https://api.pge.com/GreenButtonConnect/espi/1_1/Batch/BulkRetailCustomerInfo/{BulkID} (возвращает последний моментальный снимок информации о клиенте во время запроса) в дополнение к ежедневному уведомлению.
  2. CCA будут иметь возможность автоматически изменять свой сертификат SSL, который они изначально предоставили во время регистрации (например, когда срок действия сертификата истекает) через сторонний портал в разделе управления регистрацией > Редактировать > новый раздел: Информация о сертификате SSL (вариант обновления)

Если у вас есть какие-либо вопросы или вам нужна дополнительная поддержка, свяжитесь с нами по адресу ShareMyData@pge.com.

21 августа 2015 г.
 

Что нового:

  1. Изменения параметров состояния и ресурса URI в ответах Oauth
    • В рамках запроса кода авторизации OAuth третья сторона имеет возможность отправить параметр состояния, который PG&E отправит обратно третьей стороне. PG&E также отправит код авторизации после успешного завершения авторизации. Этот необязательный параметр состояния может быть использован для того, чтобы помочь третьей стороне определить, где был инициирован запрос, и привязать запрос обратно к авторизации, которые они инициировали.
    • В рамках успешного завершения запроса маркера мы передаем обратно ресурс URI и URI авторизации отдельно от информации о маркере. В настоящее время эти URI переворачиваются, и в рамках этого выпуска мы будем их исправлять.

Устраненные дефекты:

  1. Даты по умолчанию опубликованы - максимум и опубликованы - минимум
    В настоящее время PG&E требует от третьей стороны отправлять опубликованные минимальные и опубликованные максимальные параметры в секундах периода для каждого запроса данных, чтобы сообщить PG&E продолжительность, в течение которой они запрашивают данные. Мы вносим изменения в обработку запросов для следующих сценариев:
    • отсутствуют значения опубликованного минимума и опубликованного максимума
    • опубликованные минимальные и опубликованные максимальные значения приведены в UTC
    • опубликованные-мин. и опубликованные-макс. значения указаны в секундах периода
    В случае отсутствия параметров PG&E вернет даты по умолчанию, а не сообщения об ошибках, возвращенные до этого изменения. В нашем случае по умолчанию указаны данные за один день на дату T-2. Если параметры присутствуют и отформатированы правильно, мы продолжим соблюдать их.
  2. Исправление дат авторизации xml
    В настоящее время в разрешении xml мы предоставили опубликованную дату и дату разрешения. Эти даты выражены в миллисекундах, а не в секундах, что является стандартом. Мы исправляем его, чтобы отправить обратно через секунды периода, а не миллисекунды.
  3. Возвращен неверный XML для /resource/Subscription/{id}/UsagePoint/{id}/MeterReading/{id}/IntervalBlock
    В настоящее время мы возвращаем неправильный ответ для вышеуказанного GET уровня ресурсов, где структура XML является неверной, и мы повторяем записи для каждого интервала вместо создания одного блока интервала в течение 24 часов.

    Это фиксированное значение, и только один интервальный блок будет возвращен для 24 интервального блока.

Вопросы или опасения? Пожалуйста, свяжитесь сShareMyData@pge.com.

Часто задаваемые вопросы

  • Любая соответствующая третья сторона, заинтересованная в доступе к разрешенным клиентом данным, может использовать раздел «Передача моих данных».
  • Клиенты, обладающие техническими знаниями для использования RESTful API (интерфейс прикладной программы) для доступа к собственным данным, также могут использовать этот инструмент.
  • Если вы являетесь сторонним поставщиком услуг по реагированию на спрос (DRP), участвующим в программе PG&E согласно Правилу 24, чтобы предложить программу по реагированию на спрос и хотите использовать раздел «Передача моих данных», посетите веб-страницу DRP для получения дополнительной информации.

  • Любая соответствующая третья сторона, заинтересованная в доступе к разрешенным клиентом данным, может использовать раздел «Передача моих данных».
  • Клиенты, обладающие техническими знаниями для использования RESTful API (интерфейс прикладной программы) для доступа к собственным данным, также могут использовать этот инструмент.
  • Если вы являетесь сторонним поставщиком услуг по реагированию на спрос (DRP), участвующим в программе PG&E согласно Правилу 24, чтобы предложить программу по реагированию на спрос и хотите использовать раздел «Передача моих данных», посетите веб-страницу DRP для получения дополнительной информации.

  • Предоставление подробной информации об энергопотреблении в стандартизированном формате способствует повышению осведомленности об энергопотреблении, а также об инновациях среди третьих сторон для новых ориентированных на клиента приложений. Мы надеемся, что разработчики энергетических приложений будут представлять и создавать инновационные, вдохновляющие новые способы взаимодействия с клиентами, управления ими и, в конечном итоге, снижения их энергопотребления. Это решение является следующим шагом в национальной инициативе по обеспечению стандартизированного и легкого доступа к данным об энергопотреблении клиентов, которые позволят раскрыть возможности нового поколения решений по сохранению окружающей среды. Передача моих данных предоставляет данные в соответствии со стандартом интерфейса поставщика энергетических услуг (ESPI).
  • Целью PG&E является предоставление клиентам и их авторизованным сторонним поставщикам услуг доступа к программным данным с помощью системы «машина-машина».

  • Энергосбережение помогает сделать энергетическую сеть в Калифорнии более надежной.
  • Экономия также помогает нашим клиентам, поскольку использование меньшего количества энергии может сэкономить их деньги.
  • PG&E не получает более высокую прибыль, продавая больше энергии, что делает PG&E и другие коммунальные предприятия, принадлежащие инвесторам, в Калифорнии явно отличными от большинства компаний, которые получают прибыль, продавая больше определенного товара. Одним из способов получения PG&E денег является стимулирование, заработанное за достижение целей по энергоэффективности, установленных нашим регулирующим органом — Калифорнийской комиссией по коммунальным услугам.
  • Когда наши клиенты экономят энергию, это приносит пользу им и нашему бизнесу.

Узнайте больше о тарифах PG&E на электроэнергию

  • Использование функции «Передавать мои данные» бесплатно.

  • С помощью инструмента «Загрузить мои данные» на зеленой кнопке клиенты могут загрузить свои персональные данные об использовании и, по их желанию, отправить файл любой третьей стороне по их выбору.
  • Этот инструмент останется доступным.

  • Клиенты должны разрешить передачу своих данных третьей стороне, использующей функцию «Поделиться моими данными», или загрузить свои данные с помощью зеленой кнопки «Загрузить файл с моими данными» на свои собственные компьютеры, а затем отправить файл сторонним поставщикам услуг.

  • Да. Посетите веб-страницу ниже, чтобы просмотреть список других утилит, реализующих аналогичные программы.

Посетите веб-сайт greenbuttondata.org

  • Для этого инструмента CPUC является главным органом управления, который не имеет права получать авторизованные данные о клиентах. 
  • ЦПК рассматривает сообщения о ненадлежащем использовании данных клиентов и принимает окончательное решение о том, были ли нарушены условия Тарифа и/или Правила конфиденциальности и защиты данных клиентов.
  • Комиссия имеет право распорядиться о том, чтобы коммунальные службы немедленно аннулировали доступ и прекратили регистрацию компаний или физических лиц, нарушивших права, и запретили им участие в будущем. Для получения дополнительной информации перейдите по ссылкам ниже:
    Электрическое правило No 27 (PDF, 1,6 МБ)

  • Для получения дополнительной информации о стандарте ESPI посетите веб-сайт greenbuttondata.org.

Перед регистрацией в разделе «Поделиться моими данными» просмотрите и соберите следующую информацию.

Визит, на котором начинается обмен моими данными
Чтобы зарегистрироваться, посетите раздел «Поделиться моими данными»

  • Мы используем и поддерживаем платформу «Передавать мои данные» для облегчения регистрации компаний, желающих участвовать в программе «Передавать мои данные».
  • Мы проверяем заявителей, чтобы убедиться, что они являются законными деловыми организациями, имеющими хорошую репутацию в CPUC, что они согласны соблюдать условия и положения, а также Тариф на доступ к данным клиента, и что у них есть техническая возможность использовать платформу «Передавать мои данные».
  • Мы настоятельно рекомендуем клиентам изучить, как компании, с которыми они ведут бизнес, будут управлять и защищать свои данные.

  • PG&E будет поддерживать одно название компании и налоговый идентификатор для различных регистраций. Это означает, что у одной компании может быть несколько регистраций с разными отображаемыми именами.
  • Вам нужно будет установить соглашение с вашими клиентами, чтобы авторизовать название компании и/или отображаемое название, которое вы предоставляете при различных регистрациях.

  • Ваш федеральный налоговый идентификатор необходим для того, чтобы предоставить Калифорнийской комиссии по коммунальным услугам, принадлежащей инвесторам (Pacific Gas and Electric, Southern California Edison и San Diego Gas & Electric), а также Калифорнийской комиссии по коммунальным услугам (CPUC) общий уникальный идентификатор для вас.

  • После получения электронного письма с подтверждением того, что ваша регистрация была принята, вы сможете войти в свою учетную запись «Поделиться моими данными» для получения учетных данных клиента. Выберите Управление регистрацией, и ваш и отобразится в таблице «Контрольная точка регистрации» в разделе «Принято».>

Войдите в систему, чтобы поделиться моими данными

  • После получения электронного письма с подтверждением того, что ваша регистрация была принята, у вас есть 90 дней на прохождение регистрационного тестирования.
  • Если вы не можете пройти регистрационное тестирование в течение 90 дней, срок вашей регистрации истечет, и вам потребуется пройти повторную регистрацию.

Да, срок действия регистрации истекает. После того как ваша регистрация будет принята для тестирования, вы должны завершить тестирование и подтвердить возможность вашей организации подключиться к системам PG&E в течение 90 дней. Если вы успешно выполнили требования к тестированию и стали утвержденной третьей стороной на платформе «Передавать мои данные», срок вашей регистрации не истекает.

  • Мы не можем сбросить пароли, если вы не знаете ответа на контрольный вопрос.

  • Мы не можем сбросить пароли, если вы не знаете ответа на контрольный вопрос.

  • Вы можете войти в свою учетную запись в любое время, чтобы обновить информацию в своем профиле, выбрав Управление регистрацией.

Войдите в систему, чтобы поделиться моими данными

  • После получения сообщения электронной почты с указанием того, что ваша регистрация была принята, вы сможете войти в свою учетную запись, чтобы получить . Выберите «Управление регистрацией», и ваш отобразится в таблице «Контрольная точка регистрации» в разделе «Принято».

  • Если вы больше не хотите получать доступ к разрешенным клиентом данным на платформе Share My Data, напишите нам по адресуShareMyData@pge.com, чтобы прекратить регистрацию. Завершите увольнение в течение двух рабочих дней.

  • Клиенты разрешают вам доступ к своим данным через My Energy, свою учетную запись PG&E. Подробный обзор того, как клиенты могут разрешить третьим лицам или другим организациям доступ к их данным, см. в Обзоре обмена моими данными с третьими лицами.

Перейти к сведениям об авторизации

  • В настоящее время нет ограничений.

  • Клиенты могут выбрать определенное количество времени, в течение которого вы можете получить доступ к их данным, или оставить период авторизации открытым.
  • Ваша заявка может проверить дату окончания авторизации клиента вместе с другими данными авторизации, позвонив в API ресурса авторизации (например, .../espi/1_1/resource/Authorization и/или.../espi/1_1/resource/Authorization/{AuthorizationID}).
  • Вы также можете вручную проверить даты окончания авторизации, войдя в свою учетную запись и выбрав Управление авторизациями.

  • Если клиент выбирает определенный период авторизации, срок действия его авторизации истекает в конце этого периода времени. Если они отменяют разрешение, срок действия их разрешения истекает на следующий день после его отмены.
  • Если клиент выбирает «Неопределенно» в качестве срока авторизации, срок действия авторизации не истекает. Обратите внимание, что с учетом Поставщиков услуг по реагированию на запросы согласно Правилу 24 и других программ, использующих функцию «Передать мои данные», сторонние лица могут получать исправления после фактов для ранее утвержденных диапазонов дат в течение трех лет после истечения срока действия разрешения.
  • См. раздел «Как будут обрабатываться исправления данных?» для получения дополнительной информации о внесении исправлений.

  • Любой клиент PG&E с действующим в настоящее время сервисным идентификатором для газовой или электрической службы может разрешить вам доступ к их данным с помощью нового инструмента «Поделиться моими данными».

  • Клиентам, желающим поделиться своими данными через программу «Поделиться моими данными», настоятельно рекомендуется зарегистрироваться в учетной записи My Energy. Это сделает весь процесс более эффективным, а также позволит им управлять своими авторизациями онлайн.
  • Клиенты могут зарегистрироваться в учетной записи My Energy в процессе авторизации.
  • Клиенты могут получить онлайн-форму авторизации на передачу моих данных и отправить заполненную форму по электронной почте.
  • Для получения дополнительной информации о ручном процессе свяжитесь с нами по адресу ShareMyData@pge.com.

  • Клиенты должны самостоятельно авторизоваться онлайн через свою учетную запись PG&E. Однако, если они заполнят и подпишут форму разрешения на передачу моих данных, вы можете отправить ее в PG&E от их имени.

Загрузить форму авторизации клиента на передачу моих данных или отзыва авторизации (PDF, 308 КБ)

  • Вы можете обновить свои URI OAuth, войдя в свою учетную запись, перейдя в раздел Управление регистрацией > Редактировать > и обновив поля в разделе Информация OAuth 2.0.

  • Вы можете обновить свой URI уведомления, войдя в свою учетную запись, перейдя в раздел Управление регистрацией > Редактировать > и обновив поля в разделе Информация о доступе к данным.

  • Вы можете обновить сертификат SSL, войдя в свою учетную запись, перейдя в раздел Управление регистрацией > Редактировать > и выбрав «Обновить» в разделе Информация о сертификате SSL. Обратите внимание, что для загрузки нового сертификата может потребоваться несколько дней, чтобы обновить системы PG&E новым сертификатом.  
  • После применения нового сертификата будет отправлено электронное письмо с подтверждением от группы поддержки «Поделиться моими данными».

  • После получения электронного письма с подтверждением того, что ваша регистрация была принята, вы сможете войти в свою учетную запись «Поделиться моими данными» и загрузить наш сертификат SSL на странице «Загрузить сертификат PG&E SSL».

Войдите в систему, чтобы поделиться моими данными

  • Передача моих данных осуществляется в соответствии с соглашениями о внедрении программы «Подключить мои данные» с зеленой кнопкой. Share My Data также использует OAuth 2.0 для авторизации, Transport Layer Security (TLS) 1.2 и минимальный набор протоколов кибербезопасности, утвержденных NIST (Национальным институтом стандартов и технологий), чтобы не обмениваться четкой информацией.

  • Защита информации о клиентах является главным приоритетом для PG&E. PG&E рассматривает информацию о своих клиентах, включая личную информацию, как конфиденциальную, соответствующую всем законодательным и нормативным требованиям, включая требования, установленные Калифорнийской комиссией по коммунальным услугам и другими организациями.  
  • Уже более двух десятилетий компания PG&E и другие коммунальные предприятия, принадлежащие инвесторам в Калифорнии, подпадают под действие очень строгих правил CPUC, которые запрещают им раскрывать третьим лицам информацию, относящуюся к клиентам, такую как платежные данные, без явного согласия клиента.  
  • После того как клиент санкционирует передачу данных, ответственность за защиту этих данных лежит на клиенте и третьей стороне.
  • Клиент может прекратить передачу данных третьей стороне в любое время, войдя в свою учетную запись PG&E и отменив свое разрешение. Полная политика конфиденциальности PG&E и Уведомление о доступе, сборе, хранении, использовании и раскрытии информации об использовании энергии доступны на сайте pge.com/privacy.

  • В рамках программы «Передача моих данных» на третьих лиц распространяются Правила конфиденциальности и защиты данных клиента, указанные в условиях и положениях платформы «Передача моих данных», а также требования, включенные в Тариф на доступ к данным клиента.
  • Третьи стороны также подпадают под действие всех других применимых законов и нормативных актов, касающихся защиты конфиденциальности клиентов, включая, помимо прочего, Правила в отношении конфиденциальности и безопасности данных об использовании энергии, принятые ЦПК в качестве Приложения D к Решению 11-07-056 (электрическая система), также обобщенные в Правиле PG&E об электрооборудовании No 27 и Гражданском кодексе Калифорнии, раздел 1798.80 – 1798.84.
  • Для получения дополнительной информации перейдите по ссылкам ниже:
    Положения и условия передачи моих данных (PDF, 190 КБ)
    Электрическое правило No 27 (PDF, 1,6 МБ)
    Приложение D к решению 11-07-056 (PDF)
    Дополнительная информация:Гражданский кодекс Калифорнии, раздел 1798.80 – 1798.84

  • Подробный список поддерживаемых элементов данных см. по ссылке ниже.

Получить дополнительную информацию о доступе к данным

  • В некоторых случаях данные об использовании за определенный период отсутствуют, поскольку наши процессы проверки данных, поступающих раньше, обнаруживают отсутствие или неправильные считывания данных, которые могут потребовать дальнейшей обработки (редактирования и/или оценки).
  • Для клиентов, выставивших счет за период (например, клиентов с учетом времени использования), эти случаи корректируются вовремя, чтобы обеспечить точный расчет счета в предстоящем ежемесячном счете.

  • Если вы хотите получать исправления данных, убедитесь, что вы поставили флажок «Уведомить меня, поскольку данные готовы» во время регистрации или войдя в свою учетную запись в Интернете и установив этот флажок в разделе «Редактировать профиль». Затем мы включим исправления данных, которые были зафиксированы нашей системой в течение предыдущих 24 часов, в рамках ежедневной ленты использования, для любых данных, к которым вы имеете право доступа.
  • Исправление данных будет охватывать любые изменения в течение разрешенного периода, максимум до трех лет.

значок важной информацииПримечание. С учетом Поставщиков услуг по реагированию на запросы согласно Правилу 24 и других программ, использующих функцию «Передавать мои данные», сторонние организации могут получить исправления ранее утвержденных диапазонов дат после фактов в течение трех лет после истечения срока действия разрешения.

  • Если применимо, PG&E отправит уведомления на ваш URL-адрес уведомления, предоставленный во время регистрации. Уведомления содержат URL-адреса, соответствующие уже предварительно упакованным данным, готовым к возвращению и запросу по указанным URL-адресам. Данные предварительно упакованы и уведомления отправляются в следующих двух сценариях: (1) вы выбрали «Уведомить меня о готовности данных» в своем профиле регистрации, в этом случае мы упакуем последние ежедневные данные с любыми исправлениями за прошлые даты; или (2) вы ранее сделали специальный асинхронный запрос, для которого запрошенные данные теперь готовы. Сценарий 1 показан в разделе «DATA ACCESS: ЕЖЕДНЕВНАЯ ПОДПИСКА» раздела «Схемы доступа к данным» на странице доступа к данным и сценарий 2 проиллюстрированы в разделе «ДАННЫЙ ДОСТУП: AD HOC REQUEST (ASYNCHRONOUS)» на тех же диаграммах также на странице доступа к данным.

Доступ к данным визита выше

  • Данные об использовании электроэнергии, предоставленные компанией Share My Data, не являются данными измерителя качества расчетов (SQMD), как указано независимым системным оператором штата Калифорния (CAISO). SQMD генерируется путем умножения данных измерителя качества доходов (RQMD) на коэффициент потерь распределения (DLF), применимый к уровню напряжения этого клиента для этого интервала, преобразования измеренных интервалов в интервал, требуемый CAISO, а затем суммирования результатов для каждого интервала до совокупного уровня, требуемого CAISO.
  • PG&E внедряет флаги типа «Качество чтения» (QualityOfReading, QOR), предоставленные стандартом ESPI, чтобы сообщить, являются ли данные качеством дохода. Тип QOR регистрирует различные возможные значения качества для данных об использовании, включая явное значение для «Данные счетчика качества прибыли» или «RQMD». PG&E будет использовать этот тип QOR при передаче данных следующим образом:
    • PG&E поддерживает предоставленный ESPI класс «Обзор использования», который будет использоваться для определения дат, за которые выставляется счет за соглашение об обслуживании, суммы счета за использование и качества данных об использовании на момент запроса. Сводка по использованию будет заполнена, как только счет будет доступен для запрашиваемых данных, и будет содержать два флага (элемента) типа QOR:
      • Элемент UsageSummary.QualityOfReading (на уровне UsageSummary), указывающий качество на момент запроса последних значений использования интервала, а также исправления, соответствующие датам UsageSummary.billingPeriod.
      • Элемент качества по умолчанию для общегопотребленияПоследний период (как часть UsageSummary.OverallConsumptionLastPeriod.ReadingTypeRef), указывающий качество общего количества использований, по которым выставлен счет.
    • PG&E также сообщит данные о качестве использования на уровне интервала в момент запроса с помощью элемента IntervalReading.ReadingQuality.Quality.

  • Во время регистрации вы можете выбрать, сколько хронологических данных вам нужно, за 24, 36 или 48 месяцев в раскрывающемся списке «Какое количество хронологических данных требуется».
  • В рамках авторизации клиента, позволяющей вам получить доступ к его данным, исторический период авторизации будет установлен по умолчанию в соответствии с выбором регистрации для идентификаторов услуг (точек использования), включенных в авторизацию.
  • Вы можете обновить запрошенные исторические данные, войдя в свою учетную запись, перейдя в раздел «Управление регистрацией» > «Редактировать» > и выбрав из выпадающего списка «Сколько исторических данных запрашивается».
  • Обратите внимание, что данные, предоставленные в историческом запросе, начинаются с даты, когда клиент делает авторизацию, а не с даты, когда вы делаете запрос в API.

значок важной информацииПримечание. Изменения в запрошенных исторических данных влияют только на авторизацию новых клиентов, в то время как предыдущие авторизации клиентов будут отражать ваш выбор на момент авторизации.

  • В соответствии со стандартом ESPI в ответе используется стандарт публикации Atom. Выберите ссылку ниже, чтобы просмотреть полный список поддерживаемых API, а также доступные элементы данных.

Получить дополнительную информацию о доступе к данным

  • Активные электрические и газовые сервисные идентификаторы, установленные и считываемые PG&E, имеют право на авторизацию через платформу обмена моими данными.
  • Если идентификатор службы, связанный с авторизацией, изменяется по одной из следующих причин, авторизация перейдет к новому идентификатору службы, и доступ к историческим данным об использовании интервала будет продолжен:
    • Временное отключение из-за неуплаты
    • Перейти к выставлению счетов за интервал
    • Замена расходомера
    • Изменение тарифа
  • Другие сценарии, которые приводят к изменению идентификатора службы, такие как перемещение объектов или изменение компании, прекратят доступ. Кроме того, если учетная запись отсоединена от вашей учетной записи My Energy, все базовые сервисные идентификаторы, которые были авторизованы через раздел «Передача моих данных», будут несанкционированы.

  • Для определения детализации данных авторизованного интервала обратитесь к элементу «Длина интервала», как это предусмотрено стандартом ESPI.
  • PG&E предоставляет данные об использовании за интервал с той же детализацией, что и для выставления счетов, как правило, на почасовой или 15-минутной основе для электрических данных и на ежедневной основе для данных о газе для клиентов с интервальными счетчиками. В то время как он может варьироваться в зависимости от клиента, использование счетчика электрических интервалов обычно доступно на почасовом уровне для большинства клиентов в жилых помещениях и на уровне 15-минутного интервала для большинства коммерческих клиентов, а использование счетчиков газов обычно доступно на ежедневном уровне для большинства клиентов.
  • Для неинтервалных счетчиков данные будут предоставлены, когда они будут доступны.

  • Для подавляющего большинства клиентов PG&E с установленным Smart Meter данные об использовании электрических и газовых интервалов доступны к концу следующего дня на платформе Share My Data.
  • Небольшая часть потребителей электроэнергии PG&E с установленными счетчиками MV90 на базе водителей линии питания может потребовать дополнительного времени для получения данных.

  • Хотя мы не можем напрямую поддерживать настройку ваших API, у нас есть ряд ресурсов, которые помогут вашим ИТ- и техническим ресурсам в процессе разработки. Для получения дополнительной информации посетите страницу документации API. С любыми дополнительными вопросами обращайтесь по адресу ShareMyData@pge.com.

Для получения дополнительной информации посетите интерфейс программирования приложений (API)

Подробнее о SmartMeterη

Свяжитесь с нами

Если у вас есть вопросы или комментарии, напишите нам по адресу ShareMyData@pge.com.

Поставщики устройств

Информация для поставщиков устройств домашней сети (HAN).

Чтение SmartMeterη

На дисплее SmartMeterη отображается стрелка, указывающая, используете ли вы или экспортируете энергию.