Nota: Una computadora tradujo esta página. Si tiene preguntas, llame a servicios lingüísticos al 1-877-660-6789.
¿Qué es Compartir mis datos?
Share My Data es la próxima generación de la herramienta Green Button Connect My Data®.
¿Ya está registrado como proveedor de Share My Data aprobado?
¿Quién puede usar Compartir mis datos?
- Clientes comerciales
- Clientes residenciales
- Universidades e investigadores
- Proveedores de software
- Puesta en marcha de energía
- Empresas solares
- Agregadores de opciones comunitarias
- Respuesta de demanda
- Vehículos eléctricos
- Y muchos más
¿Cuáles son los beneficios de Compartir mis datos?
Los clientes ya no tienen que iniciar sesión en su cuenta en línea para descargar y enviar repetidamente archivos de Green Button. En cambio, una vez que un cliente autoriza a su empresa a acceder a los datos de su cuenta de PG&E, la transferencia se maneja de forma automática y repetida mediante interfaces de programación de aplicaciones (API) basadas en estándares. La plataforma Compartir mis datos incluye los datos del cliente, notifica a su sistema cuando los datos están listos y los envía de manera segura.
Acceso a datos confiable
Acceso a datos consistente y confiable a través de API. Ya no es necesario “raspar la pantalla” ni descargar datos.
API estándar
Formato API de interfaz de proveedor de servicios de energía estándar reconocido a nivel nacional para la interoperabilidad con otros proveedores de energía.
Facturación y cuenta
Los clientes de PG&E también pueden autorizar el acceso a su información de facturación y cuenta.
Cantidad y calidad de los datos
Acceda a todos los datos de uso y facturación desde una sola fuente.
Electricidad y gas
Compartir mis datos incluye datos de intervalo de cliente de PG&E para el uso de electricidad y gas.
Innovación abierta
Los casos de uso están limitados solo por su imaginación (y algunos términos y condiciones).
Comience con Compartir mis datos
- Comenzar
- Detalles de las pruebas
- Detalles de la autorización
- Acceso a datos
Existen varias maneras de acceder a los datos autorizados por el cliente a través de la API. Nuestras API más recientes siguen el estándar actual de Interfaz de proveedor de servicios de energía (Energy Service Provider Interface, ESPI) de la Junta de Normas de Energía de América del Norte (North American Energy Standards Board, NAESB) y proporcionan acceso a la Información de uso de energía (Energy Usage Information, EUI) a través de un conjunto de interfaces RESTful.
Pero primero, debe registrarse para usar la plataforma Compartir mis datos antes de que los clientes puedan autorizarlo a acceder a sus datos. Siga los pasos a continuación para obtener acceso.
Antes de comenzar el proceso de registro, asegúrese de tener la siguiente información a mano.
- Identificación fiscal: Su número de identificación de empleador (EIN) de EE. UU. de 9 dígitos
- Información de contacto comercial y técnica
- Identificadores uniformes de recursos (Uniform Resource Identifiers, URI): la plataforma Share My Data utiliza el protocolo OAUth2.0 para la autorización. Si el tipo de usuario que seleccionó requiere OAuth de tres patas para acceder a los datos, deberá proporcionar URI válidos antes de que podamos aceptar su registro.
Obtenga más información sobre los detalles de las pruebas - URI: Deberá proporcionar una URI de notificación para que nuestros sistemas puedan notificarle cuando los datos solicitados estén listos.
Obtenga más información sobre la URL de notificación en la pestaña de acceso a datos - Protocolo de transferencia segura de hipertexto (HTTPS): deberá obtener un certificado TLS1.2 X.509 válido de un proveedor SSL reconocido. No se aceptan certificados autofirmados y el envío de un certificado SSL autofirmado retrasará la aprobación de su registro.
El proceso de registro de Compartir mis datos le permite identificarse ante PG&E como una empresa, u otra entidad, que desea acceder a los datos autorizados por el cliente y configurar el acceso a nuestras API. Existen cuatro tipos de usuarios distintos para Compartir mis datos. Seleccione el tipo de usuario adecuado para el acceso solicitado.
- Usuario estándar: un usuario externo estándar. Tipo de registro: Independiente
- Usuario de acceso automático: una persona o representante de una entidad que solicita acceso a sus propios datos.
- Financiamiento de eficiencia energética: una organización que presta servicios relacionados con el pago de facturas, el financiamiento de facturas o los programas residenciales de financiamiento de eficiencia energética
- Agregador de Community Choice: un Agregador de Community Choice (CCA) registrado en el territorio de servicio de PG&E. Para revisar la lista de CCA registrados actualmente,visite Community Choice Aggregation .
Una vez que haya recopilado todos los elementos requeridos,regístrese en el Portal de API de Compartir mis datos .
Las solicitudes y respuestas de datos se realizan utilizando el protocolo HTTPS y se autentican mediante un intercambio de certificados bidireccional con PG&E. Deberá implementar certificados de seguridad para comunicaciones API entrantes y salientes seguras.
También deberá mantener certificados RSA no vencidos y no revocados con una longitud de clave pública de al menos 2048 bits. El certificado SSL es un requisito previo para completar la prueba, así que asegúrese de que su certificado esté listo y disponible. Actualmente, PG&E solo admite certificados SHA-2 X.509 emitidos por autoridades de certificados de buena reputación (PG&E no acepta certificados autofirmados), incluidos AddTrust, Comodo, DigiCert. Entrust, GlobalSign, Go Daddy,USERTrust y VeriSign.
Como usuario de Compartir mis datos, debe aceptar los Términos y condiciones de Compartir mis datos de PG&E, así como reconocer las normas de privacidad de la Comisión de Servicios Públicos de California.
Descargar los términos y condiciones de Compartir mis datos (PDF, 175 KB)
Descargar datos de protección de la privacidad y la seguridad para el uso de energía (PDF)
Confirmar dirección de correo electrónico
Al enviar su formulario de registro en línea, le enviaremos un correo electrónico a la dirección de correo electrónico de contacto comercial proporcionada. Esto es para confirmar que tenemos su información de contacto correcta. Seleccione el enlace incluido en este correo electrónico dentro de los cinco días posteriores a la recepción. Si no lo hace, deberá volver a enviar el formulario de registro en línea. Una vez que haya confirmado su dirección de correo electrónico, procesaremos su registro.
El propósito de las pruebas es verificar que puede conectarse a nuestros sistemas. Una vez que hayamos revisado su información de registro, le enviaremos un correo electrónico informándole que puede comenzar a realizar la prueba. El proceso de prueba general consta de tres componentes:
- Pruebas de conectividad API
- Prueba OAuth
- Solicitud de recursos de información de la aplicación
Continuar con las instrucciones de la prueba
Nota: Debe completar la prueba dentro de los 90 días de recibir la notificación.
Una vez completada la prueba, recibirá un correo electrónico de confirmación de que la prueba se ha completado correctamente. Después de una revisión final, el estado de su registro se moverá a Aprobado. En este punto, puede acceder a los datos y, si su tipo de usuario lo autoriza a acceder a los datos de un cliente, el cliente podrá proporcionarle una autorización. Además, los clientes que autoricen la divulgación de sus datos podrán ver que su organización tiene acceso. Si desea deshabilitar la visibilidad del cliente, puede hacerlo desde el portal de terceros.
Para obtener información sobre el proceso de autorización, visite la página Descripción general de la autorización del cliente.
Requisitos previos
Se deben cumplir los siguientes requisitos previos antes de que pueda acceder a nuestras API:
- Debe registrarse para usar la plataforma Compartir mis datos antes de que los clientes puedan autorizarlo a acceder a sus datos. Si no se ha registrado, regístrese y complete las pruebas.
- Debería haber recibido un correo electrónico que le notifica que su registro ha sido aceptado. Si no ha recibido este correo electrónico, inicie sesión en su cuenta Share My Data y seleccione "Administrar registro" para ver su estado de registro.
Es importante que complete las pruebas dentro de los 90 días posteriores a la aceptación de su registro. Si no puede completar las pruebas dentro de los 90 días, su registro vencerá y deberá volver a registrarse.
Importante: Con la excepción de los redireccionamientos del navegador durante OAuth 2.0, todas las demás solicitudes entre usted y PG&E se realizan a través de SSL mutuo y requieren que adjunte su certificado SSL de cliente a su solicitud. (Debe ser el mismo certificado que envió a PG&E antes de ser aceptado).
Se requieren los siguientes tipos de usuario para completar las pruebas de conectividad API:
Usuario estándar, acceso automático, finanzas de eficiencia energética y agregador Community Choice
Propósito:
El propósito de la prueba de conectividad de API es garantizar que pueda conectarse a las API Compartir mis datos.
Recomendado: Recuperando token de acceso de cliente usando la interfaz de usuario SOAP
Pasos de muestra para realizar el primer paso de la prueba de conectividad (recuperar un token de acceso de cliente) usando la herramienta de interfaz de usuario SOAP.
Descargue la herramienta SOAP UI (PDF, 520 KB).
Dado que las implementaciones pueden variar, esto solo pretende ser una referencia para ayudar a ilustrar cómo deben realizarse las conexiones de API a PG&E a través de SSL mutuo (bidireccional).
Pasos de la prueba de conectividad API:
Para comenzar, descargue el certificado Entrust SSL de PG&E iniciando sesión en su cuenta. Luego seleccione "Administrar registro" para recuperar su
Utilice las credenciales del cliente para obtener un token de acceso del cliente:
- Realice una solicitud POST contra la autorización TESTServerTokenEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/token
- Agregar parámetro grant_type=client_credentials.
- Agregar parámetro de encabezado de autorización básico por Base64 que codifica "client_ID:client_Secret". El parámetro del encabezado estará en el siguiente formato:
Nombre del parámetro: Autorización
Valor de parámetro: "cadena codificada base64" básica - La respuesta le dará el token de acceso del cliente y su hora de vencimiento (ejemplo):
c03a9825-16f7-400a-b546-9a206ab995db
3600
3
Bearer
Utilice el token de acceso del cliente para llamar a la API de estado del servicio:
- Realice una solicitud GET contra esta URL:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ReadServiceStatus - Pase el token de acceso del cliente en el encabezado de autorización en el siguiente formato:
Nombre del parámetro de encabezado = Autorización
Valor = portador - La respuesta debe ser la siguiente:
1
Utilice el token de acceso del cliente para solicitar los datos de muestra:
- Realice una solicitud GET contra esta URL:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/DownloadSampleData - Pase el token de acceso del cliente en el encabezado de autorización en el siguiente formato:
Nombre del parámetro de encabezado = Autorización
Valor = portador - La respuesta debe ser la siguiente:Ejemplo de lectura del medidor de descarga (XML, 273 KB)
Habrá completado la prueba de conectividad API una vez que haya recibido con éxito los datos de muestra y verá una “Prueba de conectividad API: Completado" en la tabla de hitos de registro como se muestra a continuación.
Los siguientes usuarios deben completar la prueba OAuth:
Usuario estándar y finanzas de eficiencia energética
Propósito:
El propósito de la prueba OAuth es garantizar que su implementación OAuth funcione correctamente.
Nota:
Para los fines de esta prueba, su aplicación deberá apuntar a los siguientes puntos finales para solicitar el “código de autorización de prueba” y el “token de acceso de prueba”:
- Autorización DE authorizationServerAuthorizationEndpoint https://api.pge.com/datacustodian/test/oauth/v2/authorize
- Autorización de PRUEBAServerTokenEndpoint: https://api.pge.com/datacustodian/test/oauth/v2/token
Instrucciones para la prueba OAuth:
- Inicie sesión en el Portal de terceros de Compartir mis datos
- Haga clic en "Ir>" en el cuadro Prueba OAuth
- La prueba OAuth se abrirá en una ventana nueva. Tenga en cuenta que si no se abre, asegúrese de tener el bloqueador de ventanas emergentes desactivado o deshabilitado.
- Seleccione INICIAR: Al seleccionar INICIAR, iniciará la prueba OAuth y la implementación correcta seguirá la siguiente secuencia de redireccionamientos.
Prueba ShareMyData OAuth:
Emite una redirección 302 a la URL OAuth (ThirdPartyPortalURI) que proporcionó durante el registro, con parámetros de alcance simulados:
Ejemplo:{ThirdPartyPortalURI}?scope=xxx&ThirdPartyID={dataCustodianId}
Su solicitud:
Opcional:Su aplicación: Indica (el cliente) que inicie sesión en el sitio web de su aplicación
Su solicitud:
Emite una redirección 302 al y realiza una solicitud GET para el código de autorización:
Por ejemplo, utilice este enlace SOLO PARA PRUEBAS:
OBTENGA https://api.pge.com/datacustodian/test/oauth/v2/authorize?client_id={clientID value in RegistrationMilestones}&redirect_uri={redirect_uri}&scope={scope}&response_type=code
Por ejemplo, utilice este enlace SOLO para PRODUCCIÓN:
GEThttps://sharemydata.pge.com/myAuthorization?client_id={clientID value in RegistrationMilestones}&redirect_uri={redirect_uri}&response_type=code&state={optionalState}
Prueba ShareMyData OAuth:
Emite un redireccionamiento 302 al que proporcionó durante el registro con el código de autorización ficticio:
Ejemplo: https://thirdparty.com/redirectUrl?authorization_code=7afc7c4f-778a-4ad8-8337-5e19218a2219
Su solicitud: Realice una solicitud POST para el token de acceso utilizando el código de autorización recibido y llamando al :
Nota: para la solicitud de token de acceso, debe adjuntar su certificado SSL.
Ejemplo:
PUBLICACIÓN: https://api.pge.com/datacustodian/test/oauth/v2/token?grant_type=authorization_code&code={authorizationcode}&redirect_uri={redirect_uri}
Agregar parámetro de encabezado de autorización básico por Base64 que codifica "client_ID:client_Secret"
El parámetro del encabezado tendrá el siguiente formato:- Nombre del parámetro: Autorización
- Valor de parámetro: "cadena codificada base64" básica
Prueba ShareMyData OAuth: Responde con un token de acceso de prueba:
Una respuesta exitosa se verá así:
"access_token":" 774ff105-7ad5-40c8-a6ec-f60675dc0e41"
"vence_in":"3600"
"refresh_token":998c6654-5b3b-4385-af4f-4e5c46c1bb04
"scope":"{ScopeString}"
"resourceURI":"{ResourceURI}"
"authorizationURI":"{AuthorizationURI}"
"token_type":"portador"
En este punto, habrá completado satisfactoriamente la prueba OAuth y verá una “prueba OAuth: Completado" en la tabla de hitos de registro como se muestra a continuación:
Importante: Una vez completada la prueba, debe volver a dirigir su solicitud a los puntos finales de producción para el código de autorización y la solicitud de token de acceso para que los clientes le autoricen a acceder a sus datos. Estos puntos finales se le proporcionarán en el Recurso de información de la aplicación.
Se requieren los siguientes tipos de usuario para realizar la solicitud de recursos de información de la aplicación:
Usuario estándar y finanzas de eficiencia energética
Propósito:
El propósito de la solicitud de recursos de información de la aplicación es garantizar que reciba las URL de producción para authorizationServerEndpoint y authorizationServerTokenEndpoint junto con los datosCustodianScopeSelectionScreenURI
Pasos para solicitar recursos de información de la aplicación:
Necesitará su token de acceso de registro y su identificación de información de la aplicación para solicitar el recurso de información de la aplicación.
Recuperar token de acceso de registro
Para recuperar su token de acceso de registro, inicie sesión en su cuenta Compartir mis datos y seleccione "Administrar registro". Su se mostrará en la tabla Registration Milestone cuando se acepte su registro.
Recuperar ID de información de la aplicación
Utilice el token de acceso del cliente recuperado durante la prueba de conectividad de API para llamar al xml de autorización:
Realice una solicitud GET contra esta URL:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization
Pase el token de acceso del cliente en el encabezado de autorización en el siguiente formato:
Nombre del parámetro del encabezado = Autorización
Valor = Portador
En la respuesta, verá la identificación de información de la aplicación:
Solicitar el recurso de información de la aplicación
Llame al punto final de Información de la aplicación con GET a la siguiente dirección URL: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/ApplicationInformation/{ApplicationInformationID}.
Reemplace {ApplicationInformationID} con la identificación de información de la aplicación que recuperó
Agregar parámetro de encabezado de autorización básico. El parámetro del encabezado estará en el siguiente formato:
Nombre del parámetro: Autorización
Valor de parámetro: Portador
La respuesta le dará el recurso de información de la aplicación
Importante: Para obtener instrucciones sobre cómo completar la firma, revise el Acuerdo de implementación del botón verde .
El Recurso de información de la aplicación incluirá la siguiente información:
- datosCustodianId
- datosCustodianApplicationEstado
- tercerosAplicaciónDescripción
- TerceroTipo de aplicación
- terceroTeléfono
- autorizaciónServerUri
- terceroNotificarUri
- authorizationServerAuthorizationEndpoint
- authorizationServerTokenEndpoint
- dataCustodianBulkRequestURI
- dataCustodianResourceEndpoint
- thirdPartyScopeSelectionScreenURI
- terceraPartyUserPortalScreenURI
- secreto_del_cliente
- nombre_del_cliente
- redirigir_uri
- ID_del_cliente
- ID_de_software
- versión_de_software
- ID_del_cliente_emitida_a las
- cliente_secreto_expira_a las
- contactos
- método_de_auth_de_punto_de_criterio_de_criterio_de_criterio_de_crite
- alcance
- tipos_de_subvención
- tipos_de_subvención
- tipos_de_subvención
- tipos_de_respuesta
- registro_cliente_uri
- token_de_acceso_de_registro
- datosCustodianScopeSelectionScreenURI
Si usted es un Usuario estándar o un usuario de Finanzas de eficiencia energética, este es el último de los tres requisitos de prueba y, después de la revisión, su Registro se moverá a Aprobado como se muestra a continuación. Con un registro aprobado, los clientes ahora pueden autorizarle a acceder a sus datos a través de su cuenta de My Energy o a través de un redireccionamiento a través de su sitio web utilizando la que se le proporcionó en la solicitud de recursos de información de la aplicación.
Importante: Debe redirigir su aplicación a los puntos finales de producción para el código de autorización y la solicitud de token de acceso para que los clientes lo autoricen a acceder a sus datos. Estos puntos finales se le proporcionan en el Recurso de información de la aplicación.
Para obtener más información sobre cómo los clientes otorgan a terceros acceso a sus datos, visitelos detalles de autorización.
Una vez que haya recibido la autorización del cliente, puede comenzar a utilizar nuestras API para acceder a los datos autorizados. Para obtener más información, visiteacceso a datos .
Requisitos previos
Se deben cumplir los siguientes requisitos previos antes de que pueda acceder a nuestras API:
- Debe registrarse para usar la plataforma Compartir mis datos antes de que los clientes puedan autorizarlo a acceder a sus datos. Si no se ha registrado, regístrese y complete las pruebas.
- Debe haber completado las pruebas de conectividad API y OAuth. Si aún no ha completado la prueba, consulte las instrucciones de la prueba.
Nota: los pasos de las pruebas OAuth se actualizarán en una versión futura para reflejar la funcionalidad más reciente de OAuth 2.0 descrita a continuación (es decir, eliminación de thirdPartyScopeSelectionScreenURI).
Detalles de las pruebas de la visita
Proceso de autorización
A fin de cumplir con el estándar actual de autorización de la Interfaz de Proveedor de Servicios Energéticos (Energy Service Provider Interface, ESPI) de la Junta de Normas Energéticas de América del Norte (North American Energy Standards Board, NAESB), PG&E ha implementado el marco de autorización OAuth 2.0 para autorizar el acceso a los datos. El siguiente diagrama ilustra cómo los clientes inician la autorización, eligen los parámetros del alcance y luego envían su autorización.
Material de referencia adicional más allá de la información a continuación:
Descargar el diagrama de secuencias de ESPI OAuth 2.0 (PDF, 193 KB)
Ver el SDK de datos del botón verde en Github
Nota: Para los agregadores de Community Choice, solo se necesita client_access_token para solicitar datos (a través de 2-Legged OAuth) y no se aplica lo siguiente.
Pasos para solicitar autorización
Autorizaciones iniciadas en el sitio de terceros
Para comenzar una autorización de un sitio de terceros como se ilustra en el primer diagrama anterior, se realiza una solicitud de código de autorización redirigiendo el navegador del cliente desde su sitio de terceros a la URL del punto final de autorización del servidor de PG&E con los parámetros de solicitud adecuados como se muestra a continuación. Tras la redirección, se le presentará al cliente una página de inicio de sesión de PG&E para la autenticación, seguida de una página de autorización para autorizar el acceso a los datos a su tercero:
authorizationServerAuthorizationEndpoint final (con parámetros de solicitud)
https://sharemydata.pge.com/myAuthorization?client_id=A1b2C3&redirect_uri={redirect_uri}&response_type=code&state={optionalState}
- Parámetros de solicitud obligatoria:
- client_id = ID de cliente de sus hitos de registro de Compartir mis datos (es decir, par client_id/client_secret).
- redirect_uri = URL de redireccionamiento que especificó en su registro de Compartir mis datos (las URL deben coincidir).
Nota: Recomendamos aplicar la codificación de URL al redirect_uri según el ejemplo a continuación. - response_type = código (valor estático)
- Parámetro(s) de solicitud opcional:
- estado = parámetro de estado opaco opcional según lo permitido por el estándar OAuth 2.0 que se devuelve con el código de autorización para ayudar a mantener el estado. Por ejemplo, el parámetro de estado puede ser utilizado por un tercero para identificar de manera única la creación del cliente y evitar la falsificación entre sitios.
- login={guest} Proporcione la opción de que un tercero redirija a los clientes al inicio de sesión de My Energy de PG&E o a la pestaña Guest Access como parte del flujo de autorización en línea.
EJEMPLO: Solicitud de código de autorización
OBTENGA: https://sharemydata.pge.com/myAuthorization?client_id=A1b2C3&redirect_uri=https%3A%2F%2Fthirdparty.com%2FredirectUrl&response_type=code&state=pge12advertisement
Nota: el parámetro redirect_uri de ejemplo anterior tiene codificación de URL aplicada (es decir, codificación de URL de https://thirdparty.com/redirectUrl)
Si realiza una solicitud válida como se indica anteriormente, y el cliente autentica y autoriza con éxito, el cliente será redirigido posteriormente a su redirect_uri con el código de autorización, el parámetro de alcance (autorizado) y el parámetro de estado opcional (si se proporciona como parte de la solicitud de autorización) como se muestra a continuación:
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;BlockDuration=Daily;HistoryLength={3P Registered historical length};AccountCollection={count of authorizedSAs};BR={ThirdPartyID};dataCustodianId=PGE &state=pge12advertisement
Nota: El código de autorización es de corta duración (vence en 600 segundos) y debe intercambiarse posteriormente por un token de acceso/par de tokens de actualización para completar la autorización y permitir el acceso continuo a los datos. Consulte la siguiente sección (Sección 2) para obtener detalles sobre la solicitud de token de acceso/token de actualización.
El parámetro de alcance (autorizado) que se muestra anteriormente se devuelve como parte de las respuestas a la solicitud de código de autorización, la solicitud de token de acceso y la API de autorización. Este parámetro de alcance permite comunicar el alcance final de la autorización del cliente. En particular, el parámetro de alcance incluye un valor de “Alcance adicional” que se asigna a las selecciones de autorización de clientes compatibles de PG&E de grupos de datos (p. ej., “Uso”, “Facturación”, “Básico”, “Cuenta”, “Inscripción en programas”). Los valores de los parámetros de alcance se capturan además según la siguiente documentación de referencia:Descargar asignación de cadenas de alcance de bloque de función compatible Haga clic en 2.0 (PDF, 222 KB).
Escenarios de error
Errores de implementación de terceros: si los parámetros de solicitud requeridos de client_id o redirect_uri no son válidos o faltan al solicitar un código de autorización, se mostrará al cliente un mensaje explicativo junto con el error estándar de la serie HTTP 400. De manera similar, si el parámetro de solicitud requerido de response_type falta o no es válido, el cliente será redirigido nuevamente a su redirect_uri con el parámetro de error definido como "invalid_request" de OAuth 2.0, así como el parámetro de estado opcional si se proporciona por primera vez como parte de la solicitud del código de autorización original.
Clientes que se niegan a autorizar: cuando un tercero redirecciona a un cliente para autorizar con PG&E, un cliente tiene la opción de rechazar a través de un botón de “cancelar” tanto en la página de inicio de sesión como en la página de autorización. En tales casos, el cliente será redirigido nuevamente a su redirect_uri con el parámetro de error definido como "access_denied" de OAuth 2.0 adjunto para indicar que el cliente se negó a autorizar. Además, el parámetro de estado opcional se devolverá si se proporciona por primera vez como parte de la solicitud del código de autorización original.
Autorizaciones iniciadas en PG&E
Cuando los clientes comienzan en el portal web de clientes de PG&E, "Su cuenta", y luego navegan a la página de inicio Compartir mis datos, se les presenta un menú desplegable de terceros registrados y visibles. Como se ilustra en el segundo diagrama anterior, cuando un cliente selecciona a un tercero de la lista de terceros registrados y selecciona "Siguiente", el cliente será redirigido al "URI del portal de terceros" registrado del tercero, momento en el cual los clientes pueden proceder con el proceso OAuth iniciado por el tercero descrito en la sección anterior.
Nota: Algunos terceros han consultado sobre cómo optimizar la experiencia del cliente para este caso de uso (es decir, autorizaciones iniciadas en el sitio de PG&E) de manera que al cliente parece que se los lleva directamente a una página de autorización al seleccionar un tercero del menú desplegable. Para facilitar dicha experiencia del cliente, los terceros pueden elegir configurar su "URI del portal de terceros" (a través de la página de registro de gestión de Compartir mis datos) en un punto final que redirige automáticamente al cliente de vuelta a PG&E como parte de una solicitud de código de autorización. Tras el redireccionamiento automático de vuelta al punto final de autorización del servidor de PG&E, el cliente omitirá la página de inicio de sesión del cliente (ya que ya ha iniciado sesión) y pasará directamente a la página de autorización. Para algunos terceros que se han registrado antes del lanzamiento de Share My Data Click Thru 2.0 a fines de junio de 2018, esto se puede lograr simplemente definiendo el URI del Portal de terceros para que sea igual al URI de la “Pantalla de selección de alcance de terceros” que ya no se utiliza (campo que se retirará en un lanzamiento futuro).
Por el contrario, algunos terceros pueden querer involucrar y seleccionar a los clientes de su lado cuando los clientes son redirigidos a su URI del “Portal de terceros” antes de solicitar un código de autorización, por lo que el enfoque anterior es solo una sugerencia.
Para obtener un token de acceso, utilice el código de autorización recibido y llame al siguiente punto final con los parámetros de solicitud como se describe a continuación. Como se describió anteriormente, el Código de autorización es de corta duración y vence después de 10 minutos (600 segundos), así que asegúrese de que el token de acceso se solicite de inmediato al recibir un Código de autorización.
authorizationServerAuthorizationEndpoint:https://api.pge.com/datacustodian/oauth/v2/token
- Parámetros de solicitud obligatoria:
- grant_type = código_autorización (valor estático)
- código = código de autorización recibido en respuesta a la solicitud del código de autorización
- redirect_uri = URL de redireccionamiento que especificó en su registro de Compartir mis datos (las URL deben coincidir).
Nota: Al igual que con la solicitud del código de autorización, recomendamos aplicar la codificación de URL al redirect_uri.
EJEMPLO: Solicitud de token de acceso
PUBLICACIÓN: https://api.pge.com/datacustodian/oauth/v2/token?grant_type=authorization_code&code={authorizationcode}&redirect_uri={redirect_uri}
Agregar parámetro de encabezado de autorización básico con codificación Base64 aplicada "clientID:clientSecret"
Nota: Los valores clientId:clientSecret corresponden a los valores clientID proporcionados en sus hitos de registro de Compartir mis datos.
El parámetro del encabezado tendrá el siguiente formato:
Nombre del parámetro: Autorización
Valor de parámetro: "cadena codificada base64" básica
Una respuesta exitosa se verá así:
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};AccountCollection={count of SA autorizados};BR={ThirdPartyID};dataCustodianId=PGE
resourceURI:{ResourceURI} p. ej.: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{subscriptionID}
authorizationURI:{AuthorizationURI} p. ej.: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{authorizationID}
customerResourceURI:{customerResourceURI} p. ej.:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
Bearer
Nota: Un token de acceso vence en 3600 segundos (1 hora), mientras que el token de actualización correspondiente vence en 1 año. Consulte la siguiente sección 3 para obtener detalles sobre la adquisición de un nuevo par de token de acceso/token de actualización.
Guarde el par de tokens de acceso y actualización.
Para solicitar datos históricos iniciales y datos diarios en curso,visite el acceso a datos .
Según la mejor práctica, el token de acceso es un token de corta duración (1 hora), mientras que el token de actualización correspondiente es un token de larga duración (1 año) que puede utilizar para adquirir un nuevo par de token de acceso/token de actualización cuando vence el token de acceso. Para obtener un nuevo par de token de acceso y token de actualización para autorizaciones existentes no vencidas, utilice el "token de actualización actual" y llame al siguiente punto final con los parámetros que se describen a continuación.
authorizationServerAuthorizationEndpoint :https://api.pge.com/datacustodian/oauth/v2/token ?grant_type= refresh_token&refresh_token={current_refresh_token}
EJEMPLO: Actualizar solicitud de token
PUBLICACIÓN: https://api.pge.com/datacustodian/oauth/v2/token?grant_type= refresh_token&refresh_token={current_refresh_token}
Agregar parámetro de encabezado de autorización básico con codificación Base64 aplicada "clientID:clientSecret"
Nota: Los valores clientId:clientSecret corresponden a los valores clientID proporcionados en sus hitos de registro de Compartir mis datos.
El parámetro del encabezado tendrá el siguiente formato:
Nombre del parámetro: Autorización
Valor de parámetro: "cadena codificada base64" básica
Una respuesta exitosa se verá así:
{
"access_token": "677e6ef8-1e1a-43f0-85b8-5692fcbc72b2",
"tipo_token": "Bearer",
"expira_in": 3600,
"refresh_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_
ProgramEnrollment;IntervalDuration=900_3600;BlockDuration=Daily;HistoryLength={3P Registered historical length};AccountCollection={count of authorized SA};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"
}
Nota: De manera similar, el token de acceso del cliente es un token de corta duración (1 hora), mientras que su token de actualización correspondiente es un token de larga duración (1 año) que puede utilizar para adquirir un nuevo par de token de acceso del cliente/token de actualización cuando el token de acceso del cliente caduca. Para obtener un nuevo par de Token de acceso de cliente/Token de actualización, consulte los mismos pasos descritos anteriormente.
Actualización y gestión de autorizaciones
Los clientes podrán actualizar sus autorizaciones haciendo lo siguiente:
- Eliminación de identificaciones de servicio de sus autorizaciones
- Extender la fecha de finalización del período de autorización
- Cancelación de la autorización
Nota: Los clientes solo podrán realizar cambios en sus autorizaciones iniciando sesión en su cuenta PG&E en línea y siguiendo los pasos requeridos. Si se toma alguna de estas medidas, le notificaremos a través del URI de notificación que proporcionó durante el registro.
Existen opciones para administrar y ver los detalles de las autorizaciones de sus clientes:
- Puede llamar a la API de autorización (operación http GET) utilizando su client_access_token a nivel de terceros (para obtener detalles sobre todas las autorizaciones) en https://api.pge.com/GreenButtonConnect /espi/1_1/resource/Authorization o a nivel de autorización de cliente individual en https://api.pge.com/GreenButtonConnect /espi/1_1/resource/Authorization/{AuthorizationID}.
- Por separado, también puede ver los detalles de la autorización individual manualmente iniciando sesión en su cuenta de Share My Data a través del portal de terceros e ingresando el ID de suscripción para la autorización que está buscando.
Si ya no desea acceder a los datos asociados con una autorización, existen métodos opcionales para cancelar una autorización:
- Puede llamar a la API de revocación de autorización (operación http DELETE) usando su client_access_token en https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{AuthorizationID}.
- Como alternativa, puede cancelar manualmente una autorización iniciando sesión en su cuenta de Share My Data a través del portal de terceros e ingresando la ID de suscripción para la autorización que desea cancelar.
Nota: Se notificará al cliente que usted ha elegido cancelar su autorización. Además, una vez que se cancela una autorización, la acción no puede revertirse.
Requisitos previos
Se deben cumplir los siguientes requisitos previos antes de que pueda acceder a nuestras API:
- Debe registrarse para usar la plataforma Compartir mis datos antes de que los clientes puedan autorizarlo a acceder a sus datos.
- Debería haber completado las pruebas de conectividad API y OAuth. Si aún no ha completado las pruebas, consulte las instrucciones de las pruebas.
Detalles de las pruebas de la visita - Si su tipo de usuario requiere autorización del cliente para acceder a los datos, asegúrese de que el cliente le haya otorgado autorización para acceder a sus datos y que usted haya intercambiado el código de autorización por un token de acceso. Si aún no ha recibido la autorización del cliente, revise el proceso de autorización del cliente.
Ir a detalles de autorización
Descripción general
Existen varias maneras de acceder a los datos autorizados por el cliente a través de la API. Nuestras API más recientes siguen el estándar actual de Interfaz de proveedor de servicios de energía (Energy Service Provider Interface, ESPI) de la Junta de Normas de Energía de América del Norte (North American Energy Standards Board, NAESB) y proporcionan acceso a la Información de uso de energía (Energy Usage Information, EUI) a través de un conjunto de interfaces RESTful
Descargar API compatibles (PDF, 217 KB)
El documento de API admitidas muestra las API admitidas por la implementación de Share My Data por parte de PG&E, así como la URL de API específica de PG&E.
Descargar mapeo de cadena de alcance de bloque de función compatible (PDF, 222 KB)
El documento de asignación de cadena de alcance de bloque de función compatible captura detalles sobre la cadena de alcance que se devuelve como parte de las respuestas a la solicitud de código de autorización, la solicitud de token de acceso, así como la API de autorización como se describe en la descripción general de detalles de autorización. El parámetro Alcance permite comunicar el alcance final de la autorización del cliente. Además, este documento enumera qué función estándar de ESPI bloquea la implementación de Compartir mis datos de PG&E.
Descargue el modelo de datos relacionales compatible (implementación de PG&E de ESPI) (PDF, 482 KB).
Junto con el documento Elementos de datos soportados, el Modelo de datos relacionales soportados ilustra cómo la relación entre los diferentes elementos de datos de PG&E es capturada por el estándar de ESPI.
Descargar elementos de datos compatibles (PDF, 283 KB)
El documento Elementos de datos compatibles proporciona una asignación entre los elementos de datos estándar de ESPI y los elementos de datos de PG&E.
La implementación de PG&E es compatible con las definiciones de esquema proporcionadas por ESPI que se encuentran en GitHub. Específicamente, nuestra implementación actual utiliza las siguientes versiones de esquema:
Descargar XSD (ZIP, 50 KB)
Visite Github
Consulte las siguientes fuentes sobre cómo completar la firma para cada solicitud de API y probar la llamada de API contra el Sandbox de API de GBC:
Visite la biblioteca de documentos de Green Button
Visite la API del botón verde
URI de notificación
Durante el registro, deberá proporcionar un URI de notificación para que nuestros sistemas puedan notificarle cualquier cambio en sus autorizaciones (p. ej., cancelaciones de clientes), en el caso de solicitudes de datos asíncronos (solo para conjuntos de datos más grandes) y cuando sus datos solicitados estén listos. Por separado, si desea recibir notificaciones diarias de suscripción de los datos disponibles más recientemente más cualquier corrección de datos anteriores de las últimas 24 horas, seleccione la casilla de verificación Notificarme ya que los datos están listos en su registro. Preempaquetaremos los datos del último día y le notificaremos en su URI de notificación para que regrese y recupere los datos.
Nota: Si no tiene la intención de recuperar datos diariamente, le pedimos que no marque la opción Notificarme ya que los datos están listos para reducir la cantidad de datos innecesarios que procesamos. Aún podrá realizar solicitudes ad hoc de datos.
- PG&E enviará notificaciones a su URI de notificación proporcionado durante el registro. Las notificaciones comprenden los URI correspondientes a los datos ya preenvasados listos para que regrese y solicite en las URL proporcionadas. Los datos están preempaquetados y las notificaciones se envían en los siguientes dos escenarios: (1) ha seleccionado "Notifíqueme ya que los datos están listos" en su perfil de registro, en cuyo caso empacaremos los datos diarios más recientes con cualquier corrección para fechas pasadas, o (2) ha realizado una solicitud asincrónica ad hoc anterior para la cual los datos solicitados ahora están listos.
- El Escenario 1 se ilustra en la sección “DATA ACCESS: SUSCRIPCIÓN DIARIA" de los diagramas de Métodos de acceso a datos a continuación y el Escenario 2 se ilustra en la sección “DATA ACCESS: SOLICITUD DE AD HOC (ASINCRONOSO)" de los mismos diagramas a continuación.
Métodos de acceso a datos
Ejemplos de solicitudes de datos
Tenga en cuenta la vida útil del token de los tokens de acceso, el token de acceso del cliente y sus tokens de actualización correspondientes utilizados en las solicitudes de datos. Según la mejor práctica, el token de acceso es un token de corta duración (1 hora), mientras que el token de actualización es un token de larga duración (1 año) que puede usar para adquirir un nuevo par de token de acceso/token de actualización cuando vence el token de acceso. Del mismo modo, el token de acceso del cliente es un token de corta duración (1 hora), mientras que su token de actualización correspondiente es un token de larga duración (1 año) que puede utilizar para adquirir un nuevo par de token de acceso del cliente/token de actualización cuando expire el token de acceso del cliente. Para obtener más detalles sobre cómo obtener un nuevo par de tokens, consulte el Paso 3, Solicitud de un nuevo token de acceso, en nuestra pestaña de detalles de autorización. Ir a detalles de autorización
Si usted está autorizado por el cliente a recibir “Información de cuenta” (Id. de cuenta, Id. de acuerdo de servicio y fechas de inicio del servicio) y/o “Información básica” (es decir, nombre del cliente y dirección del servicio), puede solicitar dicha información del cliente a través de las API de cliente minorista definidas por ESPI para las cuales los datos cumplen con el esquema, retailCustomer.xsd, proporcionado anteriormente.
Sincrónico (terceros estándar y EEF)
Un enfoque para solicitar datos del cliente es usar la API sincrónica para solicitar información del cliente para una autorización de cliente único para datos del cliente (es decir, cliente minorista):
Ejemplo de URL de solicitud sincrónica:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
RetailCustomerID = RetailCustomerID que recibió al final de la secuencia de autorización de OAuth para obtener un token de acceso. El ID de cliente minorista es parte del parámetro de ruta customerResourceUri en la respuesta de token. (ID del cliente minorista=ID de suscripción)
Encabezado HTTP = Autorización:Bearer {token de acceso para esta autorización}
Respuesta = recuperará los datos sincrónicamente para esa ID de cliente minorista. Los datos se ajustan al retailCustomer.xsd
Nota: La API sincrónica de cliente minorista se encuentra a nivel de cliente minorista individual que corresponde a una autorización de cliente único.
Como referencia: el siguiente diagrama jerárquico muestra la jerarquía de relaciones para los elementos de datos de ESPI en el modelado de datos de clientes de PG&E.
También puede solicitar datos de clientes a través de la API asíncrona para solicitar información de clientes para todas sus autorizaciones de clientes para datos de clientes (es decir, clientes minoristas).
Para admitir solicitudes asíncronas, su aplicación deberá admitir notificaciones posteriores que le enviaremos (según la URL de notificación que proporcionó durante el registro).
Ejemplo de URL de solicitud asíncrona:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}
BulkID = BulkID proporcionado en el Recurso de información de la aplicación recuperado durante la prueba de registro. (ID a granel=ID de cliente)
Encabezado HTTP = Autorización:Bearer {token de acceso del cliente recuperado durante la prueba de registro}
Respuesta = código de estado HTTP 202 (Esta es una solicitud asíncrona donde la respuesta se publicará en la URL de notificación cuando los datos estén listos). Una vez que los datos estén listos, PUBLICAREMOS una notificación a su URI de notificación proporcionada con una carga de URL que su aplicación puede regresar para obtener el preempaquetado. La muestra posterior a la notificación se ve como se muestra a continuación
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}?correlationID={correlationID}
Realice GET en la URL anterior con el token de acceso del cliente para obtener los datos.
Como referencia: el siguiente diagrama jerárquico muestra la jerarquía de relaciones para los elementos de datos de ESPI en el modelado de datos de clientes de PG&E.
Por último, puede obtener la información más reciente del cliente diariamente utilizando el modelo de suscripción diaria (es decir, seleccionando la casilla de verificación "Notificarme ya que los datos están listos (diariamente)" durante el registro).
Para admitir el modelo de suscripción diaria, su aplicación deberá admitir las notificaciones posteriores que le enviaremos (según la URL de notificación que proporcionó durante el registro).
Una vez que los datos estén listos, PUBLICAREMOS una notificación a su URI de notificación proporcionada con una carga de URL que su aplicación puede regresar para obtener el preempaquetado. La muestra posterior a la notificación se ve de la siguiente manera:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailCustomerInfo/{BulkID}?correlationID={correlationID}
Realice GET en la URL anterior con el token de acceso del cliente para obtener los datos.
Como referencia, el siguiente diagrama jerárquico muestra la jerarquía de relaciones para los elementos de datos de ESPI en el modelado de datos de clientes de PG&E.
Si el cliente lo autoriza a recibir “Información de uso” o “Información de facturación”, puede solicitar estos datos a través de las API de suscripción para las que los datos cumplen con el esquema, espiDerived.xsd, proporcionado anteriormente.
Solicitudes Ad Hoc sincrónicas (terceros estándar y EEF)
Para solicitar datos históricos (tanto para los datos de uso de intervalo como para los datos de factura), un enfoque es utilizar las API sincrónicas con la inclusión de parámetros de solicitud de fecha de inicio y finalización adecuados en el tiempo Zulu.
Ejemplo de URL de solicitud síncrona:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}?published-min={startDate}&published-max={endDate}
publicado-min = fecha de inicio que se aplicará a esta solicitud de extracción de datos. La fecha está en la hora Zulu de aaaa-MM-ddTHH:mm:ssZ (formato IETC RFC 3339)
publicado-máx = fecha de finalización que se aplicará a esta solicitud de extracción de datos. La fecha está en la hora Zulu de aaaa-MM-ddTHH:mm:ssZ (formato IETC RFC 3339)
Nota: Para las solicitudes de API que aceptan los parámetros de publicación máxima y de publicación mínima, el valor predeterminado es T-1 (fecha de solicitud menos 1 día). Para solicitudes de resumen de uso (p. ej., .../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/UsageSummary), sugerimos proporcionar un rango de 30 días o más para garantizar que haya una factura disponible que se superponga con ese período; de lo contrario, no se devolverán datos.
ID de suscripción = ID de suscripción que recibió al final de la secuencia de autorización de OAuth para obtener un token de acceso. El ID de suscripción es parte del parámetro resourceURI en la respuesta de token. (ID de suscripción=ID de cliente minorista)
UsagePointID = UsagePoint bajo la ID de suscripción anterior. Puede obtener todos los puntos de uso para una determinada suscripción llamando a la siguiente URL de API y suministrando el token de acceso para esa suscripción en el encabezado de autorización: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint
Encabezado HTTP = Autorización:Bearer {token de acceso para esta suscripción}
Respuesta = recuperará los datos sincrónicamente para ese punto de uso para el período solicitado. Tendrá datos de uso de intervalo () y datos de factura ().
Las API de uso sincrónico (según lo indicado por la construcción de la URL que termina con la ID de punto de uso) están en el nivel de punto de uso individual (es decir, nivel de acuerdo de servicio), por lo que una aplicación ciclaría las solicitudes a través de cada una de las ID de punto de uso que pertenecen a una autorización de cliente determinada (es decir, suscripción).
La respuesta a las solicitudes sincrónicas devuelve tanto los datos del intervalo (bajo) asociados al intervalo de fechas solicitado como cualquier total de uso mensual y facturas que se superpusieron con el intervalo de fechas solicitado (bajo ).
- IntervalReading contiene datos de uso de electricidad de intervalo (15 min/hora) y uso de gas de intervalo (diario)
- El resumen de uso contiene los totales de uso mensual y los detalles de la factura (si está autorizado)
Dentro de la respuesta encontrará elementos de datos correspondientes a nuestra tabla de mapeo de elementos de datos ESPI
Como referencia, el siguiente diagrama jerárquico muestra la jerarquía de relaciones para los elementos de datos de ESPI en el modelado de datos de clientes de PG&E.
Las siguientes son algunas aclaraciones clave sobre estos elementos de datos:
- El bloqueo de intervalo es para 1 día
- IntervalReading (debajo del bloqueo de intervalo) contiene los valores reales de uso de electricidad de 15 minutos/hora y los valores diarios de uso de gas
- Para los clientes de electricidad con generación en el sitio (p. ej., solar), el elemento flowDirection indica los datos de uso entregados (suministro) y recibidos (generación). Para los clientes con medidores configurados para leer solo el uso neto (es decir, sin generación en el sitio), el elemento flowDirection indica que el uso es un monto neto (diferencia de entregado menos recibido):
- Dirección de flujo de 1 = administrada (energía suministrada al cliente)
- Dirección de flujo de 19 = recibido (generación neta que regresa a la red de PG&E). (Tenga en cuenta que los valores son absolutos)
- Dirección de flujo de 4 = neto (entregado menos – recibido)
- Preste especial atención al poder de diez multiplicadores y a la unidad de medida (uom) para garantizar una lectura correcta del uso
Suscripción por lotes (terceros estándar y EEF)
También puede solicitar datos de uso a través de la API asíncrona para todos los puntos de uso pertenecientes a una autorización de un solo cliente para datos de uso/facturación (es decir, suscripción).
Para admitir las solicitudes asíncronas ad hoc (es decir, para más de un Punto de uso a la vez), su aplicación deberá admitir Notificaciones posteriores que le enviaremos (según la URL de notificación que proporcionó durante el registro).
Ejemplo de URL de solicitud asíncrona
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}?published-min={startDate}&published-max={endDate}
ID de suscripción = ID de suscripción que recibió al final de la secuencia OAuth para obtener un token de acceso. El ID de suscripción es parte del parámetro resourceURI en la respuesta de token
publicado-min = fecha de inicio que se aplicará a esta solicitud de extracción de datos. (formato RFC 3339, hora del zulu. aaaa-MM-ddTHH:mm:ssZ)
publicado-máx = fecha de finalización que se aplicará a esta solicitud de extracción de datos. (formato RFC 3339, hora del zulu. aaaa-MM-ddTHH:mm:ssZ)
Encabezado HTTP = Autorización:Bearer {token de acceso para esta suscripción}
Respuesta = código de estado HTTP 202 (esta es una solicitud asíncrona donde la respuesta se publicará en la URL de notificación cuando los datos estén listos)
Una vez que los datos estén listos, PUBLICAREMOS una notificación a su URI de notificación proporcionada con una carga de URL que su aplicación puede regresar para obtener el preempaquetado. La muestra posterior a la notificación se ve de la siguiente manera:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Subscription/{SubscriptionID}?correlationID={correlationID}
Realice GET en la URL anterior con token de acceso para obtener los datos. Esto contendrá tanto los datos de uso del intervalo () como la información de la factura () para el período solicitado.
Suscripción por lotes (terceros estándar y EEF)
También puede solicitar información de uso y facturación a través de la API asíncrona masiva por lotes para todas las autorizaciones de sus clientes para datos de uso/facturación (es decir, Suscripciones).
Ejemplo de URL de solicitud masiva de lote
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?published-min={startDate}&publishedmax={endDate}
BulkID = BulkID proporcionado en el Recurso de información de la aplicación recuperado durante la prueba de registro. (ID a granel=ID de cliente)
publicado-min = fecha de inicio que se aplicará a esta solicitud de extracción de datos. (formato RFC 3339, hora del zulu. aaaa-MM-ddTHH:mm:ssZ)
publicado-máx = fecha de finalización que se aplicará a esta solicitud de extracción de datos. (formato RFC 3339, hora del zulu. aaaa-MM-ddTHH:mm:ssZ)
Encabezado HTTP = Autorización:Bearer {token de acceso de cliente}
Respuesta = código de estado HTTP 202 (esta es una solicitud asíncrona donde la respuesta se publicará en la URL de notificación cuando los datos estén listos)
Una vez que los datos estén listos, PUBLICAREMOS una notificación a su URI de notificación proporcionada con una carga de URL que su aplicación puede regresar para obtener el preempaquetado. La muestra posterior a la notificación se ve de la siguiente manera:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?correlationID={correlationID}
Realice GET en la URL anterior con token de acceso para obtener los datos. Esto contendrá tanto los datos de uso del intervalo () como la información de la factura () para el período solicitado.
Por último, puede obtener la información más reciente sobre el uso y la facturación, incluidas las correcciones de fechas pasadas dentro de los períodos de autorización del cliente a diario utilizando el modelo de suscripción diaria (es decir, seleccionando la casilla de verificación “Notificarme ya que los datos están listos (diariamente)” durante el registro).
Para admitir el modelo de suscripción diaria, su aplicación deberá admitir las notificaciones posteriores que le enviaremos (según la URL de notificación que proporcionó durante el registro).
Una vez que los datos estén listos, PUBLICAREMOS una notificación a su URI de notificación proporcionada con una carga de URL que su aplicación puede regresar para obtener el preempaquetado. La muestra posterior a la notificación se ve de la siguiente manera:
https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/Bulk/{BulkID}?correlationID={correlationID}
Realice GET en la URL anterior con token de acceso para obtener los datos. Esto contendrá tanto los datos de uso del intervalo () como la información de la factura () para el período solicitado.
- Kits de desarrollo de software (SDK)
- Bloque funcional, API, elemento de datos
- Conexión de botón verde
- Condiciones de uso aceptables
- Notas de la versión
Kits de desarrollo de software (SDK)
Para ayudar con el desarrollo de software para conectarse a la plataforma Share My Data, es útil ver el mecanismo detallado involucrado en cada llamada a los puntos finales de API publicados. Con este fin, PG&E tiene algunos SDK de muestra que ha desarrollado en el pasado para JavaScript y Python para ilustrar aspectos clave de la conexión a la plataforma Share My Data. Estos SDK proporcionan muestras de código para guiarlo a través del proceso de desarrollo, pero no pretenden proporcionar código de producción. Para JavaScript, deberá instalar NodeJS y asegurarse de "instalar npm - guardar ..." para actualizar los módulos relevantes de la biblioteca NodeJS. El código no es independiente, sino que proporciona fragmentos que ilustran cómo se produce la interacción entre un código de cliente de datos de terceros y los servicios de la API Compartir mis datos de PG&E.
Para ayudar con la implementación de la plataforma Share My Data, PG&E desarrolló SDK tanto en JavasScript como en Python. Estos SDK proporcionan muestras para guiarlo a través del proceso de desarrollo, pero no pretenden proporcionar código de funcionamiento.
Descargar API compatibles (PDF)
El documento de API admitidas muestra las API admitidas por la implementación de Share My Data por parte de PG&E, así como la URL de API específica de PG&E.
Descargar asignación de cadena de alcance de bloque de función compatible (PDF)
El documento Asignación de cadena de alcance de bloque de función compatible captura detalles sobre la cadena de alcance que se devuelve como parte de las respuestas a la solicitud de código de autorización, la solicitud de token de acceso, así como la API de autorización como se describe en laDescripción general de detalles de autorización. El parámetro Alcance permite comunicar el alcance final de la autorización del cliente. Además, este documento enumera qué función estándar de ESPI bloquea la implementación de Compartir mis datos de PG&E.
Descargar el modelo de datos relacionales admitido (implementación de PG&E de ESPI) (PDF)
Junto con el documento Elementos de datos soportados, el Modelo de datos relacionales soportados ilustra cómo la relación entre los diferentes elementos de datos de PG&E es capturada por el estándar de ESPI.
Descargar elementos de datos compatibles (PDF)
El documento Elementos de datos compatibles proporciona una asignación entre los elementos de datos estándar de ESPI y los elementos de datos de PG&E.
La implementación de PG&E es compatible con las definiciones de esquema proporcionadas por ESPI que se encuentran en GitHub. Específicamente, nuestra implementación actual utiliza las siguientes versiones de esquema:
Descargar XSD (ZIP)
Visite Github
Consulte las siguientes fuentes sobre cómo completar la firma para cada solicitud de API y para probar la llamada de API contra el Sandbox de API de GBC:
Visite la biblioteca de documentos de Green Button
Visite la API del botón verde
La implementación de Share My Data sigue el estándar nacional de Interfaz de proveedores de servicios de energía (Energy Service Provider Interface, ESPI). El estándar también ha sido marcado como la iniciativa Green Button Connect My Data (GBCMD) promovida por el director de Tecnología de la Casa Blanca y los becarios de innovación presidencial. El estándar de ESPI describe el marco técnico para ofrecer funcionalidad en torno a la autorización del cliente, el intercambio de datos y el formato de los datos autorizados que se intercambian. Estos detalles se cubren en la documentación estándar de ESPI y GBCMD. Encuentre la documentación en Green Button Data .
Para utilizar Compartir mis datos, los terceros primero deben obtener y proporcionar un certificado digital X.509 de una autoridad de certificación de confianza en sus servidores de conexión API. Luego, los terceros pueden completar el registro con PG&E en el sitio de registro de terceros, cargar su certificado allí también, recibir credenciales de PG&E que les permitan probar su conexión y, posteriormente, obtener tokens portadores a través de nuestros puntos finales de token de autorización de custodio de datos. Estos tokens portadores se describen en el estándar OAuth2 y permiten que el software de terceros conecte de forma segura las API de acceso a datos de PG&E. Los SDK proporcionan detalles de interacción sobre cómo obtener los tokens en el código de script.
Los tokens portadores de acceso al cliente y los tokens portadores de acceso a datos del cliente se obtienen por separado y se denominan tokens de acceso al cliente y tokens de acceso, respectivamente. Los tokens de acceso se obtienen según la autorización individual del cliente de PG&E. Un flujo de trabajo típico es aquel que sigue a OAuth2, según el mecanismo de autorización estándar (IETF 6749), donde un cliente comienza en un sitio de terceros, y ese sitio redirige al cliente a https://sharemydata.pge.com/#MyAuthorization/ primero para su autenticación. Allí, el cliente se autentica con PG&E y pasa por un alcance que define la autorización de su acceso a los datos al tercero (proceso de “clic”). Al finalizar, PG&E redirige de nuevo al tercero con una respuesta HTTP 302, por lo que el tercero está listo para obtener tokens portadores (token de acceso). Revise un flujo detallado del proceso (PDF, 463 KB).
El servidor cliente de datos de terceros se conecta a los puntos finales API de acceso a datos de PG&E mediante una conexión mutua TLS 1.2. El acceso individual al punto final de la API controlado por tokens portadores; una vez que se acepta y procesa una solicitud, los datos se devuelven en una respuesta síncrona o una respuesta asíncrona basada en una notificación a una URL especificada por un tercero.
Los datos siguen el esquema de ESPI mencionado anteriormente. Revise una descripción de los elementos compatibles (PDF, 283 KB).
PG&E publica datos de acuerdo con el alcance permitido para el tipo de tercero y la autorización del cliente.
Revise una definición del alcance (XLSX ), y también siga las definiciones del alcance del botón verde .
Antes de registrarse para usar Compartir mis datos, le recomendamos encarecidamente que usted y su organización se familiaricen con los siguientes recursos:
Visite el SDK de datos del botón verde
Herramientas para crear, probar y mostrar archivos de datos del botón verde. Encuentre los SDK desarrollados por PG&E: JavaScript (ZIP, 1.7 MB)| Python (ZIP, 5 KB)
Visite el Sandbox de la API del botón verde
Este sandbox de API permite a los desarrolladores tener acceso completo, en formato de botón verde, a la información de uso de energía con el fin de desarrollar nuevas aplicaciones de botón verde.
Debido a los recursos finitos del sistema, así como para permitir que PG&E reduzca los riesgos operativos, se han implementado los siguientes límites de umbral de API para garantizar la estabilidad continua de la plataforma para nuestros usuarios.
- Una solicitud por segundo por proveedor en todos los ID de cliente del proveedor
- 2000 llamadas de API por hora por ID de cliente
- 20 000 llamadas de API por período de 24 horas por ID de cliente. El límite de umbral diario se restablece a las 5 p. m. PT
Tenga en cuenta que nuestras condiciones de uso aceptables están sujetas a cambios. El equipo de Share My Data evalúa continuamente nuestra capacidad de respaldar solicitudes de terceros a medida que la plataforma crece y más usuarios se integran con el sistema. Sin embargo, nos aseguraremos de comunicar cualquier cambio antes de la implementación.
Consulte las siguientes notas de la versión para conocer las mejoras y los cambios que hemos realizado en Compartir mis datos. Si tiene un problema con Compartir mis datos o tiene una sugerencia para mejorar el servicio, comuníquese con nosotros a ShareMyData@pge.com.
20 de junio de 2024
La plataforma Share My Data (SMD) de PG&E para compartir datos autorizados por el cliente con proveedores de servicios externos lanzó la fase 2 de nuestra mejora de identificación del medidor, lo que permite la identificación de la identificación del medidor individual asociada con los datos del medidor de intervalo eléctrico.
Esta mejora es particularmente útil para escenarios de usuario donde varios medidores están asociados con un acuerdo de servicio.
Fase 1: Publicado en marzo de 2023: se modificaron las API afectadas para comenzar a agregar un valor junto con el valor en la respuesta devuelta, bajo la etiqueta . Existe una correspondencia uno a uno entre el valor serialNumber y el valor utcNumber.
Esta información permite a los proveedores que utilizan estas API crear un almacén de registros con el utcNumber junto con el valor de número de serie asociado con un medidor determinado para su base de clientes antes de que se publique la mejora de la Fase 2.
Fase 2: Publicado el 20 de junio de 2024: reemplaza los valores de MeterReadingID del formato de codificación actual64 de los valores descriptivos del medidor por el utcNumber. Una vez que estos cambios se implementen por completo, los usuarios de Share My Data tendrán una capacidad mejorada para vincularse con el uso de intervalos de medidores específicos, en los casos en que haya varios medidores de la misma mercancía vinculados a un único acuerdo de servicio en las instalaciones, con la identificación específica del medidor que generó el uso.
Las siguientes API se ven afectadas por los cambios de la fase 2
API afectada:
.../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}
Todos los demás API con lecturas de intervalo no cambian y representan la SUMA de los intervalos del medidor en ambas direcciones de flujo y con todos los medidores en virtud de un acuerdo de servicio.
Antes de la liberación, el campo MeterReadingID estaba codificado en Base64 y el valor devuelto muestra lo siguiente:
MeterReadingID= TnpJNmJuVnNiRG96TmpBd09qRT06MTox
Decodificado del formato Base64 como: NzI6bnVsbDozNjAwOjE =:1:1
Esto muestra readingTypeID:rownum:count, y el valor readingTypeID se decodifica de Base64 nuevamente como:
72:null:3600:1 donde los valores son uom:phase:intervalLength:flowDir
UDM = 72, fase = nulo, intervaloLongitud = 3600 y flujoDir = 1 (administrado)
En la Fase 2, el campo MeterReadingID se anexa con caracteres adicionales y, después de pasar por una decodificación inicial, se mostrarán los siguientes resultados de ejemplo
MeterReadingID=TnpJNmJuVnNiRG96TmpBd09qRT06MToxOjQ0MTEzMTA1NDYgICAgICAgICAg
Decodificado de Base64 una vez: NzI6bnVsbDozNjAwOjE =:1:1:4411310546,
Esto muestra que meter_UUID es 4411310546, y este valor debe coincidir con el valor disponible en la API RetailCustomer bajo la etiqueta .
El valor de “NzI6bnVsbDozNjAwOjE=:1:1:” es la lecturaTypeID:rownum:count, es decir, el número de fila es 1 y el recuento es 1 relacionado con los registros internos de la base de datos de PG&E. El readingTypeID se decodifica nuevamente como:
72:null:3600:1, donde los valores son uom:phase:intervalLength:flowDir
UDM = 72, fase = nulo, intervaloLongitud = 3600 y flujoDir = 1 (administrado)
Este cambio permite a los usuarios especificar el medidor físico y la dirección de flujo de interés en las lecturas de intervalo. Tenga en cuenta que todos los archivos XML ahora llevarán los nuevos valores de MeterReadingID y aplicarán la nueva forma de codificación de fase 2. Compartir mis datos informa a todos los proveedores que utilizan cualquier llamada de API usando MeterReadingID, realice la siguiente llamada de API para obtener el nuevo MeterReadingID: .../espi/1_1/resource/Subscription/{SubscriptionID}/UsagePoint/{UsagePointID}/MeterReading
20 de marzo de 2023
Novedades:
- Liberación de un nuevo código de respuesta API HTTP (204) para llamadas API síncronas y asíncronas para indicar cuando no hay datos disponibles para el rango solicitado.
- Admite una etiqueta de encabezado de transacción x que admite la capacidad de vincular la respuesta de PG&E a llamadas de API asíncronas específicas al devolver este valor junto con una ID de correlación cuando el archivo solicitado está listo.
- Se mejoró la granularidad de datos adicionales a la API UsagePoint/MeterReadingID al proporcionar datos de intervalos eléctricos para varios medidores en escenarios de acuerdos de servicio individuales.
- Se proporcionó claridad adicional a los valores del indicador de calidad de lectura para los datos del intervalo ESTIMADO para describir el tipo de estimación utilizada para ese intervalo. Los nuevos valores que indican que se ha aplicado la lógica de estimación son los siguientes:
Valor y descripción del RQI
0 - Válido: datos que han pasado por todas las verificaciones de validación requeridas y que las han aprobado todas o han sido verificados
7 - Editado manualmente: reemplazado o aprobado por un humano
8 - Estimado usando el día de referencia: el valor de los datos se reemplazó por un valor computado por la máquina basado en el análisis de los datos históricos usando el mismo tipo de medición
9 - Estimado usando interpolación lineal: el valor de los datos se calculó usando interpolación lineal en función de las lecturas antes y después
10 - Cuestionable: datos que han fallado en una o más verificaciones
11 - Derivado: datos que se han calculado (usando operaciones lógicas u matemáticas), no necesariamente medidos directamente
12 - Proyectado (previsión): datos que se han calculado como una proyección o pronóstico de lecturas futuras
13 - Mezclado: indica que la calidad de esta lectura tiene características mixtas
14 - Sin procesar: datos que no han pasado por el proceso de validación, edición y estimación. NOTA El indicador RQI de los medidores MV90 permanecerá en 14 como estado RQ final
15 - Normalizado para el clima: los valores se han ajustado para tener en cuenta el clima, para comparar el uso en diferentes climas
16 - Otro: especifica que se aplica una característica distinta de las definidas
17 - Validado: datos que han sido validados y posiblemente editados y/o estimados de acuerdo con los procedimientos aprobados
18 - Verificado: datos que fallaron en al menos una de las verificaciones de validación requeridas, pero se determinó que representaban el uso real
19 - Calidad de los ingresos: válido y aceptable para fines de facturación [posible extensión para el estándar ESPI y que no forme parte del ESPI original]
- Publicación de métricas de uso de API de proveedores en el portal de proveedores de Share My Data Third Party.
15 de noviembre de 2018
Novedades:
- Se agregó el indicador de clase de cliente. Cada SAID que esté autorizado se identificará como RES, AGR, COM/IND u otro.
- Las API de facturación y uso se actualizarán para aceptar los parámetros de consulta actualizados-máx y actualizados-mín (como alternativa a los parámetros publicados-mín y publicados-máx). Los datos devueltos serán todos los cambios que se hayan producido dentro de los parámetros de máximo y mínimo actualizados.
- Reemplazar el uso de la identificación masiva de 5 dígitos de un tercero con la identificación de cliente del tercero para el flujo de autorización en línea.
- Proporcionar la opción de que un tercero redirija a los clientes al inicio de sesión de la cuenta de PG&E o a la pestaña Acceso de invitados como parte del flujo de autorización en línea.
- Mejorar el panel de clientes de Share My Data de PG&E para facilitar a los clientes la visualización de todas sus autorizaciones de intercambio de datos existentes con terceros.
27 de septiembre de 2018
Novedades:
PG&E agregó nuevos elementos de datos al conjunto de datos de la Regla 24 como parte del proyecto de conjunto de datos expandidos (EDS) de PG&E, y los nuevos elementos de datos correspondientes se introducen en el conjunto de datos de la Regla 25. Los elementos de datos específicos que comprenden el conjunto de datos ampliados de la Regla 25 de PG&E se establecen a continuación con la designación EDS:
Elementos de datos de la Regla 25
Notas
Elementos de la cuenta
Nombre de la cuenta
Dirección de la cuenta
ID de cuenta
EDS: Bloqueo de corte
Elementos de servicio
UUID de PG&E
ID de servicio
Cambios futuros en el estado del servicio
Estado de SA
Fecha de inicio del servicio
Dirección de servicio
Tarifa de servicio actual
Tarifa histórica del servicio facturado
Opciones de tarifas (Medical Baseline, CARE, FERA, TBS, CCA_TBS, Solar Choice
Voltaje de servicio actual y voltaje de servicio facturado histórico de productos básicos
Número del medidor de servicio
Cantidad de medidores de servicio
Tipo de medidor
Ciclo de lectura del medidor de corriente
Ciclo histórico de lectura del medidor facturado
Opción de tasa de espera actual si el indicador de generación en el sitio
Opción histórica de tarifa en espera facturada
EDS: Indicador de clase de cliente
Elementos históricos de facturación
Fecha de inicio de la factura
Fecha de finalización de la factura
Cargos totales de facturación($)
Total de kWh de facturación
EDS: Nombre del proveedor de servicios
Desglose histórico del nivel de facturación (si lo hubiera)
EDS: Período de facturación de elementos de línea
EDS: Nombre (sobre el inicio 1 %-30 %)
EDS: Volumen (1234.2)
EDS: tarifa ($0.032/kWh)
EDS: Costo ($100.23)
Desglose histórico de TOU kWh de facturación (excepto para ABS-TX facturado)
EDS: Período de facturación de elementos de línea (para desglose de TOU)
EDS: Nombre (del cargo de TOU)
EDS: Volumen (1234.2)
EDS: tarifa ($0.032/kWh)
EDS: Costo ($100.23)
Desglose histórico de la demanda de facturas
EDS: Período de facturación de elementos de línea (para desglose de demanda)
EDS: Nombre
EDS: Volumen (1234.2)
EDS: tarifa ($0.032/kWh)
EDS: Costo ($100.23)
Elementos históricos de la línea de facturación
EDS: Período de facturación de elementos de línea
EDS: Nombre del cargo (cargo de bono DWR)
EDS: Volumen (1234.2)
EDS: Unidad (kWh)
EDS: tarifa ($0.032/kWh)
EDS: Costo ($100.23)
Intervalos de uso históricos
Inicio de uso de intervalo
Duración predeterminada del intervalo (en segundos)
Volumen de uso del intervalo (1234.2)
Unidad (kWh/termias)
Programas de respuesta a la demanda de servicios públicos
(DR) Nombre del programa
Fecha de finalización más temprana sin obligación financiera
Fecha de finalización más temprana independientemente de la obligación financiera
Estado del programa DR
Fecha de inscripción en el programa DR
Fecha de cancelación de la inscripción en el programa DR
Elementos de datos
Mercancía
Parámetros de hora local (detalles de DST)
Calidad de datos predeterminada
Dirección de energía
Potencia de diez multiplicadores (para valores de uso de intervalo)
Poder de diez multiplicadores (para la demanda facturada)
Potencia de diez multiplicadores (para el uso total facturado)
Duración del intervalo(de lectura de uso)
Moneda del costo total de la factura
Indicadores TOU de intervalo eléctrico
28 de junio de 2018
Como parte del proyecto Click-Through y las mejoras continuas a la plataforma Share My Data, PG&E lanzó la fase 2 de Click-Through el 28 de junio de 2018.
Novedades:
Los cambios más críticos que afectan a terceros son los cambios para cumplir con el protocolo OAuth 2.0 (PG&E eliminó la serie inicial de redireccionamientos). Encuentre los detalles a continuación.
IMPORTANTE: Se REQUIERE que los terceros realicen cambios en su implementación OAuth existente. Los cambios de la Fase 2 de Click-Through de PG&E NO son compatibles con versiones anteriores, por lo que es necesario que terceros implementen cambios concurrentes con la implementación de PG&E. Sin implementación, el proceso actual de autorización del cliente dejará de funcionar en la fecha de corte del 29 de junio de 2018. Sin embargo, las autorizaciones existentes no se ven afectadas.
- Para cumplir con el protocolo OAuth 2.0, PG&E ha reducido la cantidad de pasos de redireccionamiento para la autorización. La redirección inicial a PG&E para que los clientes inicien sesión y envíen una autorización se ha combinado con la solicitud del código de autorización de la siguiente manera:
- Como se muestra en el ejemplo a continuación, las solicitudes de código de autorización de terceros ahora comprenden un redireccionamiento del navegador del cliente a la nueva authorizationServerAuthorizationEndpoint URI, junto con los parámetros de solicitud adecuados:
OBTENGA https://sharemydata.pge.com/myAuthorization?client_id=xxxxx&redirect_uri={redirect_uri}&response_type=code&state={optionalState} - Se ha retirado el siguiente punto final: https://api.pge.com/datacustodian/oauth/v2/authorize...
- Como se muestra en el ejemplo a continuación, las solicitudes de código de autorización de terceros ahora comprenden un redireccionamiento del navegador del cliente a la nueva authorizationServerAuthorizationEndpoint URI, junto con los parámetros de solicitud adecuados:
- Nuevos mensajes de manejo de errores para solicitudes de código de autorización con parámetros de alcance faltantes o no válidos de la siguiente manera:
- Si faltan o no son válidos los parámetros client_id o redirect_uri requeridos, se muestra un error (http 400) con un mensaje explicativo al cliente
- Si falta el parámetro response_type requerido o no es válido, el cliente será redirigido nuevamente al redirect_uri del tercero con un parámetro de error "invalid_request" (anexado al redirect_uri)
- Para los clientes con una autorización en línea existente, la capacidad de un tercero de solicitar un nuevo par access_token/refresh_token como parte de una nueva autorización que reemplaza a la existente (es decir, autorización en línea de la misma combinación de tercero y cliente). Esta funcionalidad aborda situaciones en las que terceros pierden un par access_token/refresh_token o necesitan cambiar el alcance de la autorización original según la aprobación del cliente.
- Para las solicitudes de reautorización, el cliente ve la nueva página de autorización en lugar de la página de “administrar autorización” cuando un tercero la redirige a PG&E para su autorización.
- Tras la autorización del cliente, los terceros reciben una notificación a su URL de notificación registrada de que se cancela la ID de suscripción anterior (la notificación comprende el punto final de la URL de la API de autorización para la ID de suscripción anterior)
- La capacidad de un cliente de salir a través de un botón "cancelar" en la página de autenticación o en la página de autorización con redirección de regreso al redirect_uri del tercero con un parámetro de error "access_denied" (adjunto al redirect_uri)
- Para terceros que se registran con la configuración de "visibilidad" en y, por lo tanto, se incluyen en la lista de terceros registrados, los clientes verán cuándo van a su cuenta en línea de PG&E y navegan a la página de inicio de Compartir mis datos:
- Para los clientes que inician sesión en su cuenta en línea de PG&E y navegan a la página de inicio Compartir mis datos y luego son redirigidos a la "URI del portal de terceros" registrada de terceros al seleccionar un tercero de la lista de terceros registrados. En ese momento, los clientes pueden continuar con el proceso OAuth iniciado por terceros. Al seguir esta ruta, los clientes ya no aparecerán en la página de autorización al seleccionar un tercero de la lista desplegable de terceros, sino que serán redirigidos al "URI del portal de terceros" registrado del tercero, donde pueden comenzar el proceso OAuth iniciado por el tercero.
- Nota: Algunos terceros han consultado sobre cómo optimizar la experiencia del cliente para este caso de uso (es decir, autorizaciones iniciadas en el sitio de PG&E) de manera que al cliente parece que se los lleva directamente a una página de autorización al seleccionar un tercero del menú desplegable. Para facilitar dicha experiencia del cliente, los terceros pueden elegir establecer su "URI del portal de terceros" (a través de la página de registro de gestión de Compartir mis datos) en un punto final que redirige automáticamente al cliente de vuelta a PG&E como parte de una solicitud de código de autorización. Tras el redireccionamiento automático de vuelta a authorizationServerAuthorizationEndpoint, el cliente omitirá la página de inicio de sesión del cliente (ya que ya ha iniciado sesión) y irá directamente a la página de autorización. Para algunos terceros que se han registrado antes de la versión Compartir mis datos Click Thru 2.0, esto se puede lograr simplemente definiendo el URI del portal de terceros para que sea igual a la “Pantalla de selección de alcance de terceros” ya no utilizadaURI (el campo de registro SMD anterior se retirará en una versión futura).
Por el contrario, es posible que algunos terceros quieran primero involucrar y seleccionar a los clientes de su lado cuando los clientes sean redirigidos a su URI del “Portal de terceros” antes de solicitar un código de autorización, por lo que el enfoque anterior es solo una sugerencia.
- SMD ahora proporcionará detalles mejorados del parámetro Alcance como parte de las respuestas a la Solicitud de código de autorización, la Solicitud de token de acceso y la API de autorización. El parámetro de alcance mejorado permite comunicar el alcance final de la autorización del cliente. En particular, el parámetro de alcance incluye un valor de “Alcance adicional” que se asigna a las selecciones de autorización de clientes compatibles de PG&E de grupos de datos (p. ej., “Uso”, “Facturación”, “Básico”, “Cuenta”, “Inscripción en programas”). Los valores de los parámetros de alcance se capturan además según la siguiente documentación:Descargar asignación de cadena de alcance de bloque de función compatible Haga clic en 2.0 (PDF)
A continuación, se muestra un ejemplo de respuesta de token que ilustra algunos posibles valores de parámetros de alcance.- Ejemplo de respuesta de 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};AccountCollection={count of SA autorizados};BR={ThirdPartyID};dataCustodianId=PGE
resourceURI:{ResourceURI} p. ej.: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Subscription/{subscriptionID}
authorizationURI:{AuthorizationURI} p. ej.: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{authorizationID}
customerResourceURI:{customerResourceURI} p. ej.:https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailCustomer/{RetailCustomerID}
Bearer
- Ejemplo de respuesta de token:
- Los terceros ahora pueden registrarse para recibir información autorizada sobre la inscripción en el programa a través del nuevo grupo de datos “Inscripción en el programa”. Tanto los clientes con medidor de intervalo como los clientes con medidor sin intervalo serán elegibles para autorizar el intercambio de datos para la Fase 2 de clics en SMD. A continuación, se presenta un resumen de alto nivel de los elementos de datos recientemente disponibles proporcionados por el grupo de datos de inscripción en el programa:
- Inscripción en el programa (nombre/estado del programa de respuesta a la demanda de PG&E e información de CAISO):
- (Facturación) Dirección de la cuenta
- Estado del acuerdo de servicio
- Tarifa de servicio (actual)
- (corriente) Voltaje de servicio (solo eléctrico)
- Número de medidor de servicio (si corresponde)
- Tipo de medidor
- Ciclo de lectura del medidor (corriente)
- (Actual) Opción de tasa de espera si es indicador de generación en el sitio
- (uso del intervalo predeterminado) Duración (longitud en segundos)
- (Respuesta a la demanda de PG&E inscrita) Nombre del programa (si corresponde)
- Fecha de finalización más temprana del Programa de respuesta a la demanda (Demand Response, DR) inscrito en PG&E sin obligación financiera
- Fecha de finalización más temprana del Programa de respuesta a la demanda (Demand Response, DR) inscrito en PG&E, independientemente de la obligación financiera
- Estado (inscripción) del Programa de respuesta a la demanda (Demand Response, DR) de PG&E
- Fecha de inscripción en el programa de respuesta a la demanda (Demand Response, DR) de PG&E
- Fecha de desafiliación del programa de respuesta a la demanda (Demand Response, DR) de PG&E
- La asignación de XML XSD (Definición de esquema XML) de Atom para estos nuevos elementos de datos se captura de acuerdo con la siguiente documentación:
Descargar elementos de datos compatibles (PDF) - El modelo de jerarquía de datos relacionales asociados se describe de la siguiente manera:
Descargar el modelo de datos de PGE ESPI (PDF) - Punto de uso (también conocido como SA UUID)
- ServiceDeliveryPoint\tariffProfile(tarifa de servicio actual, también conocida como lista de tarifas, incluida la opción de tarifa en espera, si corresponde)
- readCycle (ciclo de lectura del medidor actual)UsoResumen
- readCycle (ciclo de servicio de facturación)
- Producto básico (incluye el nivel de voltaje facturado para electricidad)
- TarifaPerfil (tarifa de servicio facturada, incluida la opción de tarifa en espera, si corresponde
- Tipo de lectura
- Producto básico (incluye el nivel de voltaje de corriente para electricidad y prefijo para la opción de tasa de espera cuando corresponda)
- Cuenta del cliente
- (Dirección de facturación de la cuenta):
- principalDirección/calleDetalle...
- principalDirección/puebloDetalle...
- principalDirección/código postal...
- Acuerdo con el cliente
- estado\valor (estado de SA
- Programa de respuesta a la demanda
- nombre del programa
- inscripciónEstado
- programDate/programDate
- programFecha/programaFechaDescripción
- Medidor
- número de serie (id. del medidor)
- tipo (tipo de medidor)
- Intervalo (actual)Duración
- Las últimas definiciones de esquema de ESPI xml (XSD) utilizadas para estos nuevos elementos de datos se describen de la siguiente manera:
Descargar XSD (ZIP)
Nota: los XSD son compatibles con versiones anteriores.
- Los terceros tendrán la capacidad de cambiar su registro para permitir que los clientes seleccionen este grupo de datos durante el tiempo de autorización a través del portal de terceros en Administrar registro >Editar > sección: Indique la información del cliente que necesita", seleccione la casilla de verificación Inscripción en el programa.
- Nota:esto solo se aplicará a las autorizaciones de nuevos clientes.
- Las nuevas API para recuperar la información de inscripción de DR están disponibles a nivel de terceros masivos, así como a nivel de autorización de cliente individual (nivel de ID de cliente minorista), según se describe a continuación:
Descargar nuevas API compatibles con PGE (PDF)
- API asíncrona para solicitar información de inscripción de DR para todas las autorizaciones a un tercero
- https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/BulkRetailDRPrgInfo/{BulkID}
- API síncrona para solicitar información de inscripción de DR a nivel de autorización de cliente individual
- https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Batch/RetailDRPrgInfo/{RetailCustomerID}
Tenga en cuenta que: Además de los cambios en el proceso de autorización del cliente, otros cambios también son compatibles con versiones anteriores y son mejoras voluntarias que los terceros pueden optar por respaldar.
Si tiene alguna pregunta o necesita asistencia adicional, no dude en enviar un correo electrónico a sharemydata@pge.com.
Novedades:
- Los clientes ahora pueden beneficiarse del proceso simplificado de autorización mediante clics.
- Hemos actualizado los detalles sobre cómo un cliente ahora puede compartir datos con su empresa.
Conozca cómo los clientes comparten datos con una empresa
Nota: Estos cambios, particularmente las mejoras a nuestra UI de autorización, se han optimizado para dispositivos móviles (p. ej., teléfonos o tabletas). - Se han realizado cambios en el proceso de gestión de autorización accesible para los clientes a través de su cuenta en línea de PG&E:
- Un cliente aún puede eliminar SAID de una autorización existente, extender la fecha de finalización de la autorización y/o cancelar la autorización en cualquier momento. Sin embargo, para agregar SAID adicionales y/o cambiar los elementos de datos autorizados, es necesario cancelar la autorización existente y crear una nueva autorización.
- Hemos actualizado los detalles sobre cómo un cliente ahora puede compartir datos con su empresa.
- Si lo desea, los terceros ahora pueden utilizar esta API para revocar autorizaciones de clientes individuales utilizando su token de acceso de cliente de terceros (proporcionado durante el proceso inicial de registro de terceros SMD) a través de una operación DELETE: https://api.pge.com/GreenButtonConnect/espi/1_1/resource/Authorization/{AuthorizationID}
Nota 1:Para la implementación de PG&E, el parámetro ID de autorización es el mismo valor que el ID de suscripción.
Nota 2:La nueva API proporciona a terceros la capacidad de revocar (cancelar) una autorización. Sin embargo, solo los clientes mismos pueden eliminar las identificaciones de SA y/o actualizar la fecha de finalización de la autorización a través de nuestras páginas de administración de autorizaciones de SMD.
Recordatorio:Al igual que con todas las solicitudes de datos de API, los terceros primero deben solicitar un nuevo par de tokens (Acceso de cliente + Actualizar token) utilizando sus últimos tokens de actualización.
Recordatorio de períodos de vencimiento de tokens:- Token de acceso:1 hora
- Token de acceso del cliente: 5 min
- Tokens de actualización correspondientes: 1Yr
- Los terceros ahora pueden crear múltiples registros de Compartir mis datos (SMD) utilizando el mismo nombre de compañía e identificación fiscal si es necesario. Sin embargo, el nombre de visualización (que los clientes ven cuando autorizan) aún debe ser único.
Nota:Todos los cambios anteriores son compatibles con versiones anteriores y son mejoras voluntarias que los terceros pueden elegir admitir. Descargue los documentos de respaldo para esta versión:
COMPATIBLE_APIS.SMD_CLICK-THRU_1.0 (PDF)
COMPATIBLE_DATA_ELEMENTS_RETAILCUSTOMER.SMD_CLICK_THRU_1.0 (PDF)
PGE_ESPI_DATA_MODEL.SMD_CLICK-THRU_1.0 (PDF)
COMPATIBLE_DATA_ELEMENTS_ESPIDERIVED.SMD_CLICK_THRU_1.0 (PDF)
ESPI_XSDS (ZIP)
20 de diciembre de 2015
Cambios requeridos:las siguientes actualizaciones de SMD 2.0 requieren cambios por parte de terceros.
- En consideración de terceros con implementaciones de GBCMD (Green Button Connect My Data) en múltiples utilidades además de solo PG&E, devolveremos los datosCustodianID (es decir, dataCustodianID=PGE) en la redirección a thirdPartyScopeSelectionScreenURI durante la secuencia de autorización OAuth.
- Las solicitudes de API que acepten parámetros de fecha (p. ej., solicitud de lote) deben usar parámetros de datos de Zulu (p. ej., publicado-máx./publicado-mín.). No se admitirán otros formatos de fecha para los parámetros de fecha en las solicitudes de API.
- Las API que aceptan parámetros de fecha se documentan según las API admitidas.xlsx adjuntas
- Indicadores de TOU de intervalo incluidos con los datos de uso de electricidad medidos por intervalo (según corresponda, indicador de a qué período de TOU corresponde cada intervalo)
- Consulte las asignaciones estáticas de ID del programa que detallan a qué corresponde cada enumeración de TOU de intervalo (p. ej., 1 = Pico de verano, etc.). (Consulte el documento adjunto,Elementos de datos compatibles.xlsx )
- La Id._cliente que se encuentra en los datosCustodianScopeSelectionScreenURI (utilizada para OAuth iniciada por terceros) y proporcionada en la solicitud de terceros de Recursos de información de la aplicación durante la Prueba de registro se actualiza a 5 dígitos si aún no lo está (p. ej., agregar ceros iniciales, etc.). Además, la URL ya no incluye '&verified=true' al final. Los terceros deberán actualizar sus URL en consecuencia.
- Para elaborar, los datosCustodianScopeSelectionScreenURI se ven de la siguiente manera: https://sharemydataqa.pge.com/myAuthorization/?clientId=XXXX (XXXX es la identificación del cliente)
- Por lo tanto, un clientID actual de 123 cambiará a algo como 00123, lo que significa que sus nuevos datosCustodianScopeSelectionScreenURI serán los siguientes:
https://sharemydataqa.pge.com/myAuthorization/?clientId=00123 (la URL anterior es la siguiente: https://sharemydataqa.pge.com/myAuthorization/?clientId=00123&verified=true)
- Los terceros registrados como "ESP" o "Proveedor de servicios de energía" cambiarán a Tipo de usuario estándar. No hay cambios funcionales, solo en el título del tipo de usuario. Distinguir el tipo de usuario ESP (del tipo de usuario estándar) es una diferenciación innecesaria, lo que causa confusión durante el proceso de registro sin proporcionar ninguna funcionalidad diferenciada, por lo que se retira.
Mejoras opcionales: Los siguientes cambios son compatibles con versiones anteriores y son mejoras voluntarias que los terceros pueden elegir respaldar.
- Los terceros tendrán la capacidad de cambiar/actualizar automáticamente sus certificados SSL que proporcionaron originalmente durante el registro (p. ej., cuando el certificado se acerque al vencimiento) a través del portal de terceros bajo administrar registro >Editar > nueva sección: Información del certificado SSL (opción Actualizar).
- Los terceros pueden registrarse para recibir información de facturación básica autorizada, información del cliente y datos de gas. Tanto los clientes con medidor de intervalo como los clientes sin medidor de intervalo serán elegibles para autorizar el intercambio de datos para SMD 2.0. A continuación se presenta un resumen de alto nivel de los elementos de datos recientemente disponibles:
- Información de facturación: (para SA medidos con intervalo y sin intervalo)
- Lista de tarifas, totales de $ de facturación, uso escalonado (según corresponda), demanda (según corresponda), totales de TOU (según corresponda)
- Nota: Para los clientes autorizados con medidor sin intervalo, los terceros solo recibirán totales de uso de facturación (es decir, en Resumen de uso) y lecturas de uso sin intervalo (p. ej., lecturas por hora/diarias, ya que no están disponibles)
- Información del cliente: (para SA medidos con intervalo y sin intervalo)
- Nombre del cliente, dirección de servicio, identificación de cuenta, identificación del acuerdo de servicio, fecha de inicio del servicio del acuerdo de servicio,
- Datos de uso de gas de intervalo: (solo SA de gas medido de intervalo)
- Lecturas de gases de intervalo (es decir, diarias)
- Los nuevos elementos de datos se diagraman según el documento adjunto,Elementos de datos compatibles.xlsx
- La jerarquía de datos relacionales asociados se describe en el documento adjunto,PGE ESPI Data Model.xlsx
- Las últimas definiciones de esquema de xml (XSD) de ESPI utilizadas para estos nuevos elementos de datos son según las XSD adjuntas. Nota:los XSD son compatibles con versiones anteriores:
- espiDerived.xsd (Información de facturación y uso del intervalo)
- retailcustomer.xsd (información del cliente)
- Información de facturación: (para SA medidos con intervalo y sin intervalo)
Si tiene alguna pregunta o necesita ayuda adicional, no dude en comunicarse con nosotros a ShareMyData@pge.com.
18 de diciembre de 2015
Cambios requeridos: las siguientes actualizaciones de SMD 2.0requieren cambios por parte de aquellos usuarios que acceden a sus propios datos:
- Las solicitudes de API que acepten parámetros de fecha (p. ej., solicitud de lote) deben usar parámetros de datos de Zulu (p. ej., publicado-máx./publicado-mín.). No se admitirán otros formatos de fecha para los parámetros de fecha en las solicitudes de API.
- Las API que aceptan parámetros de fecha se documentan según las API admitidas.xlsx adjuntas
- Indicadores de tiempo de uso (TOU) del intervalo incluidos con los datos de uso de electricidad medidos del intervalo (según corresponda, indicador del período de TOU al que corresponde cada intervalo)
- Consulte las asignaciones estáticas de ID del programa que detallan a qué corresponde cada enumeración de TOU de intervalo (p. ej., 1 = Pico de verano, etc.). (Consulte el documento adjunto,Elementos de datos compatibles.xlsx )
Mejoras opcionales: Los siguientes cambios son compatibles con versiones anteriores y son mejoras voluntarias que los terceros pueden elegir respaldar.
- Los usuarios de acceso automático tendrán la capacidad de cambiar/actualizar automáticamente sus certificados SSL que proporcionaron originalmente durante el registro (p. ej., cuando el certificado se acerque a su vencimiento) a través del portal de terceros en Administrar registro > Editar > sección nueva: Información del certificado SSL (opción Actualizar)
- Se actualizarán los registros de usuarios de Autoacceso para incluir información básica de facturación autorizada, información del cliente y datos de gas. Ambos acuerdos de servicio con intervalo medido también como acuerdos de servicio sin intervalo medido serán elegibles para (auto) autorización para SMD 2.0. A continuación se presenta un resumen de alto nivel de los elementos de datos recientemente disponibles:
- Información de facturación: (para SA medidos con intervalo y sin intervalo)
- Lista de tarifas, totales de $ de facturación, uso escalonado (según corresponda), demanda (según corresponda), totales de TOU (según corresponda)
- Nota: Para los clientes autorizados con medidor sin intervalo, los terceros solo recibirán totales de uso de facturación (es decir, en Resumen de uso) y lecturas de uso sin intervalo (p. ej., lecturas por hora/diarias, ya que no están disponibles)
- Información del cliente: (para SA medidos con intervalo y sin intervalo)
- Nombre del cliente, dirección de servicio, identificación de cuenta, identificación del acuerdo de servicio, fecha de inicio del servicio del acuerdo de servicio,
- Datos de uso de gas de intervalo: (solo SA de gas medido de intervalo)
- Lecturas de gases de intervalo (es decir, diarias)
- Los nuevos elementos de datos se diagraman según el documento adjunto,Elementos de datos compatibles.xlsx
- La jerarquía de datos relacionales asociados se describe en el documento adjunto,PGE ESPI Data Model.xlsx
- Las últimas definiciones de esquema de xml (XSD) de ESPI utilizadas para estos nuevos elementos de datos son según las XSD adjuntas. Nota:los XSD son compatibles con versiones anteriores:
- espiDerived.xsd (Información de facturación y uso del intervalo)
- retailcustomer.xsd (información del cliente)
- Información de facturación: (para SA medidos con intervalo y sin intervalo)
Si tiene alguna pregunta o necesita ayuda adicional, no dude en comunicarse con nosotros a ShareMyData@pge.com.
18 de diciembre de 2015
Cambios requeridos: las siguientes actualizaciones de SMD 2.0 requieren cambios por parte de las implementaciones de CCA.
- Las solicitudes ad hoc (p. ej., para datos históricos) deben realizarse utilizando parámetros de fecha y hora de Zulu. No se admitirán otros formatos de fecha para los parámetros de fecha en las solicitudes de API.
- La alimentación diaria de uso masivo comenzará a incluir información básica de facturación, mientras que la alimentación diaria masiva del cliente incluirá información adicional del cliente. Estos nuevos datos se proporcionarán tanto para los clientes con medidor de intervalo para los que reciben datos actualmente, como para los clientes sin medidor de intervalo en su territorio para los que no reciben datos actualmente. Por último, los valores de uso del intervalo proporcionados en la alimentación diaria de uso a granel incluirán indicadores de TOU del intervalo cuando corresponda. El resumen de alto nivel de los nuevos elementos de datos es el siguiente:
- Información de facturación: (para SA medidos con intervalo y sin intervalo)
- Lista de tarifas, totales de $ de facturación, uso escalonado (según corresponda), demanda (según corresponda), totales de TOU (según corresponda)
- (adicional) Información del cliente: (para SA medidos con intervalo y sin intervalo)
- Nombre del cliente, dirección del servicio, fecha de inicio del servicio del acuerdo de servicio, identificación de la cuenta
- Indicadores de TOU de intervalo incluidos con los datos de uso de electricidad medidos por intervalo (según corresponda, indicador de a qué período de TOU corresponde cada intervalo)
- Consulte las asignaciones estáticas de ID del programa que detallan a qué corresponde cada enumeración de TOU de intervalo (p. ej., 1 = Pico de verano, etc.). (Consulte el documento adjunto,Elementos de datos compatibles.xlsx )
- Las últimas definiciones de esquema de xml (XSD) de ESPI utilizadas para estos nuevos elementos de datos son según las XSD adjuntas. Tenga en cuenta que los XSD son compatibles con versiones anteriores:
- espiDerived.xsd (Información de facturación y uso del intervalo)
- retailcustomer.xsd (Información del cliente)
- Los nuevos elementos de datos se diagraman según el documento adjunto,Elementos de datos compatibles.xlsx
- La jerarquía de datos relacionales asociados se describe en el documento adjunto,PGE ESPI Data Model.xlsx
- Información de facturación: (para SA medidos con intervalo y sin intervalo)
Mejoras opcionales: Los siguientes cambios son compatibles con versiones anteriores y son mejoras voluntarias que los terceros pueden elegir respaldar.
- Los CCA pueden realizar solicitudes ad hoc de información del cliente en: https://api.pge.com/GreenButtonConnect/espi/1_1/Batch/BulkRetailCustomerInfo/{BulkID} (devuelve la última instantánea de información del cliente al momento de la solicitud), además de la notificación diaria recibida.
- Los CCA tendrán la capacidad de cambiar automáticamente su certificado SSL que proporcionaron originalmente durante el registro (p. ej., cuando el certificado se acerque a su vencimiento) a través del portal de terceros, bajo administrar registro > Editar > nueva sección: Información del certificado SSL (opción Actualizar)
Si tiene alguna pregunta o necesita ayuda adicional, no dude en comunicarse con nosotros a ShareMyData@pge.com.
21 de agosto de 2015
Novedades:
- Cambios de parámetros estatales y URI de recursos en las respuestas de Oauth
- Como parte de la solicitud del código de autorización OAuth, el tercero tiene la opción de enviar un parámetro de estado que PG&E enviaría de vuelta al tercero. PG&E también enviará el código de autorización una vez completada con éxito la autorización. Este parámetro estatal opcional se puede utilizar para ayudar al tercero a identificar dónde se inició la solicitud y vincular la solicitud con las autorizaciones que inició.
- Como parte de la finalización exitosa de la solicitud de token, compartimos los recursosURI y autorizaciónURI por separado de la información del token. Actualmente, estas URI se voltean y, como parte de este lanzamiento, lo corregiremos.
Defectos fijos:
- Fechas predeterminadas publicadas-máx. y publicadas-mín.
Actualmente, PG&E exige que el tercero envíe parámetros de mín. y máx. publicados en segundos de época para cada solicitud de datos para informar a PG&E la duración durante la cual solicita datos. Estamos implementando un cambio para manejar las solicitudes para los siguientes escenarios:- faltan los valores de mín. y máx. publicados
- los valores mín. y máx. publicados están en UTC
- los valores de mín. publicado y máx. publicado están en segundos de época
- Corregir para fechas en autorización xml
Actualmente en la autorización xml compartimos la fecha de publicación y la fecha de autorización. Estas fechas están en milisegundos en lugar de segundos, que es el estándar. Lo arreglamos para que se envíe en segundos en lugar de milisegundos. - Se devolvió un XML incorrecto para /resource/Subscription/{id}/UsagePoint/{id}/MeterReading/{id}/IntervalBlock
Actualmente estamos devolviendo una respuesta incorrecta para el nivel de recurso anterior GET donde la estructura del XML es incorrecta y estamos repitiendo entradas para cada intervalo en lugar de crear un solo bloque de intervalo para una duración de 24 horas.
Esto se está fijando y solo se devolverá un solo bloque de intervalo para un bloque de intervalo de 24.
¿Tiene preguntas o inquietudes? Comuníquese con ShareMyData@pge.com.
- Preguntas generales
- Registro
- Autorización
- Acceso a datos
- Cualquier tercero calificado interesado en acceder a datos autorizados por el cliente puede usar Compartir mis datos.
- Los clientes con el conocimiento técnico para usar las API de RESTful (Interfaz del programa de aplicación) para acceder a sus propios datos también pueden usar la herramienta.
- Si usted es un proveedor externo de respuesta a la demanda (DRP) que participa en virtud del programa de la Regla 24 de PG&E para ofrecer un programa de respuesta a la demanda y desea usar Compartir mis datos, visite la página web de DRP para obtener más información.
- Cualquier tercero calificado interesado en acceder a datos autorizados por el cliente puede usar Compartir mis datos.
- Los clientes con el conocimiento técnico para usar las API de RESTful (Interfaz del programa de aplicación) para acceder a sus propios datos también pueden usar la herramienta.
- Si usted es un proveedor externo de respuesta a la demanda (DRP) que participa en virtud del programa de la Regla 24 de PG&E para ofrecer un programa de respuesta a la demanda y desea usar Compartir mis datos, visite la página web de DRP para obtener más información.
- Poner a disposición información detallada sobre el uso de la energía en un formato estandarizado fomenta la concientización sobre el uso de la energía, así como la innovación entre terceros para nuevas aplicaciones centradas en el cliente. La esperanza es que los desarrolladores de aplicaciones de energía imaginen y creen nuevas formas innovadoras e inspiradoras para que los clientes se relacionen, gestionen y, en última instancia, reduzcan su consumo de energía. Esta solución es el siguiente paso en un esfuerzo nacional para proporcionar un acceso estandarizado y fácil a los datos de energía del cliente que desbloqueará la próxima generación de soluciones de conservación. Share My Data proporciona los datos siguiendo el estándar de la Interfaz de proveedor de servicios de energía (Energy Service Provider Interface, ESPI).
- El objetivo de PG&E es poner a disposición de los clientes y sus proveedores de servicios externos autorizados acceso a datos programáticos, de máquina a máquina, recurrentes y autorizados.
- La conservación de energía ayuda a que la red de energía en California sea más confiable.
- Conservar también ayuda a nuestros clientes, ya que usar menos energía puede ahorrarles dinero.
- PG&E no gana más al vender más energía, lo que hace que PG&E y otras empresas de servicios públicos propiedad de inversionistas en California sean claramente diferentes de la mayoría de las empresas que obtienen ganancias vendiendo más de un producto determinado. Una forma en que PG&E gana dinero es a través de incentivos obtenidos al lograr los objetivos de eficiencia energética establecidos por nuestro regulador, la Comisión de Servicios Públicos de California.
- Cuando nuestros clientes conservan energía, es bueno para ellos y para nuestro negocio.
- El uso de Compartir mis datos no tiene costo alguno.
- A través de la herramienta Green Button Download My Data, los clientes pueden descargar sus datos de uso personal y, si así lo desean, enviar el archivo a cualquier tercero que elijan.
- Esta herramienta permanecerá disponible.
- Los clientes deben autorizar la divulgación de sus datos a un tercero utilizando Compartir mis datos o descargar sus datos a través del botón verde Descargar archivo de mis datos a sus propias computadoras y luego enviar el archivo a proveedores de servicios externos.
- Sí. Visite la página web a continuación para ver una lista de otras utilidades que están implementando programas similares.
- Para esta herramienta, la CPUC es la autoridad rectora final sobre quién no es elegible para recibir datos de clientes autorizados.
- La CPUC revisa los informes de uso indebido de los datos de los clientes y toma las determinaciones finales en cuanto a si se han violado los términos de las Normas de protección y privacidad de los datos de los clientes y/o tarifas.
- La Comisión tiene la autoridad de ordenar a las empresas de servicios públicos que revoquen inmediatamente el acceso y finalicen el registro de empresas o personas que estén en infracción y les prohíba participar en el futuro. Para obtener más información, seleccione los siguientes enlaces:
Regla eléctrica n.o 27 (PDF, 1.6 MB)
- Para obtener más información sobre el estándar ESPI, visite greenbuttondata.org.
Revise y recopile la siguiente información antes de registrarse en Compartir mis datos.
Visita para comenzar a compartir mis datos
Para registrarse, visite Compartir mis datos
- Operamos y mantenemos la plataforma Compartir mis datos para facilitar el registro de las compañías que desean participar en el programa Compartir mis datos.
- Seleccionamos a los solicitantes para verificar que sean entidades comerciales legítimas en regla con la CPUC, que acepten cumplir con los términos y condiciones y la Tarifa de acceso a datos del cliente y que tengan la capacidad técnica para usar la plataforma Compartir mis datos.
- Recomendamos encarecidamente que los clientes investiguen cómo las empresas con las que eligen hacer negocios gestionarán y protegerán sus datos.
- PG&E respaldará el nombre de una compañía y la identificación fiscal para diversos registros. Esto significa que una sola empresa puede tener varios registros con diferentes nombres de visualización.
- Deberá establecer la comprensión con sus clientes para autorizar el nombre de la compañía y/o el nombre de visualización que proporcione en su registro.
- Se requiere su identificación fiscal federal para proporcionar a los servicios públicos de California (Pacific Gas and Electric, Southern California Edison y San Diego Gas & Electric) y a la Comisión de Servicios Públicos de California (California Public Utilities Commission, CPUC) un identificador único y común para usted.
- Vaya a la sección “Detalles de la prueba” de esta página anterior.
- Una vez que reciba un correo electrónico que indique que su registro ha sido aceptado, podrá iniciar sesión en su cuenta de Share My Data para recuperar sus credenciales de cliente. Elija Administrar registro y su y aparecerán en la tabla Hito de registro bajo el estado Aceptado.>
- Una vez que reciba un correo electrónico que indique que su registro ha sido aceptado, tiene 90 días para completar la prueba de registro.
- Si no puede completar la prueba de registro dentro de los 90 días, su registro vencerá y deberá volver a registrarse.
Sí, el registro vencerá. Una vez que se acepte su registro para las pruebas, debe completar las pruebas y confirmar la capacidad de su organización para conectarse a los sistemas de PG&E dentro de los 90 días. Si ha completado con éxito los requisitos de prueba y se convierte en un tercero aprobado en la plataforma Compartir mis datos, su registro no vencerá.
- No podemos restablecer las contraseñas si no conoce la respuesta a su pregunta de seguridad.
- No podemos restablecer las contraseñas si no conoce la respuesta a su pregunta de seguridad.
- Puede iniciar sesión en su cuenta en cualquier momento para actualizar la información de su perfil seleccionando Administrar registro.
- Una vez que reciba un correo electrónico que indique que su registro ha sido aceptado, podrá iniciar sesión en su cuenta para recuperar su . Seleccione "Administrar registro" y su se mostrará en la tabla Hito de registro bajo el estado Aceptado.
- Si ya no desea acceder a los datos autorizados por el cliente en la plataforma Compartir mis datos, envíenos un correo electrónico a ShareMyData@pge.compara que se cancele su registro. Espere hasta dos días hábiles para que se complete la finalización de la relación laboral.
- Los clientes lo autorizan a acceder a sus datos a través de My Energy, su cuenta en línea de PG&E. Para obtener una descripción general detallada de cómo los clientes pueden autorizar a terceros u otras entidades a acceder a sus datos, consulte la Descripción general de terceros de Compartir mis datos.
- Actualmente, no hay límite.
- Los clientes pueden elegir una cantidad específica de tiempo durante el cual puede acceder a sus datos o pueden dejar abierto el período de autorización.
- Su solicitud puede verificar la fecha de finalización de la autorización de un cliente junto con otros detalles de autorización llamando a las API de recursos de autorización (p. ej., .../espi/1_1/resource/Authorization y/o.../espi/1_1/resource/Authorization/{AuthorizationID}).
- Como alternativa, puede verificar manualmente las fechas de finalización de la autorización iniciando sesión en su cuenta y seleccionando Administrar autorizaciones.
- Si un cliente elige un período de autorización definido, entonces su autorización vence al final de ese período. Si cancelan la autorización, su autorización vence el día después de que la cancelen.
- Si un cliente elige Indefinido como su período de autorización, entonces su autorización no vence. Tenga en cuenta que, en consideración de los Proveedores de respuesta a la demanda de la Regla 24 y otros programas que utilizan Compartir mis datos, las correcciones posteriores a los hechos para los rangos de fechas previamente autorizados pueden proporcionarse a terceros durante un máximo de tres años después del vencimiento de la autorización.
- Consulte “¿Cómo se manejarán las correcciones de datos?” para obtener más detalles sobre cómo recibir correcciones.
- Cualquier cliente de PG&E con una identificación de servicio actualmente activa para servicio de gas o electricidad puede autorizarlo a acceder a sus datos utilizando la nueva herramienta Compartir mis datos.
- Se recomienda encarecidamente a los clientes interesados en compartir sus datos a través del programa Compartir mis datos que se registren en una cuenta de My Energy. Esto hará que todo el proceso sea más eficiente y también les dará la capacidad de administrar sus autorizaciones en línea.
- Los clientes pueden registrarse para una cuenta My Energy durante el proceso de autorización.
- Hay un proceso manual disponible para que los clientes obtengan un Formulario de autorización para compartir mis datos en línea y envíen el formulario completo por correo electrónico.
- Para obtener más información sobre el proceso manual, comuníquese con nosotros a ShareMyData@pge.com.
- Los clientes deben hacer sus propias autorizaciones en línea a través de su cuenta en línea de PG&E. Sin embargo, si completan y firman el formulario de autorización para compartir mis datos, puede enviarlo a PG&E en su nombre.
- Puede actualizar sus URI de OAuth iniciando sesión en su cuenta, navegando a Administrar registro > Editar > y actualizando los campos en la sección Información de OAuth 2.0.
- Puede actualizar su URI de notificación iniciando sesión en su cuenta, navegando a Administrar registro > Editar > y actualizando los campos en la sección Información de acceso a datos.
- Puede actualizar su certificado SSL iniciando sesión en su cuenta, navegando a Administrar registro > Editar > y seleccionando "Actualizar" en la sección Información del certificado SSL. Tenga en cuenta que para las nuevas cargas de certificados, puede llevar varios días actualizar los sistemas de PG&E con el nuevo certificado.
- Se enviará un correo electrónico de confirmación del equipo de soporte de Compartir mis datos cuando se haya aplicado el nuevo certificado.
- Una vez que reciba un correo electrónico que indique que su registro ha sido aceptado, podrá iniciar sesión en su cuenta Share My Data y descargar nuestro certificado SSL a través de la página Descargar certificado SSL de PG&E.
- Compartir mis datos sigue los acuerdos de implementación de Green Button Connect My Data. Share My Data también emplea OAuth 2.0 para autorización, Seguridad de la capa de transporte (Transport Layer Security, TLS) 1.2 y el conjunto mínimo de protocolos de ciberseguridad aprobados por el Instituto Nacional de Estándares y Tecnología (National Institute of Standards and Technology, NIST) de manera que no se intercambie información de manera clara.
- Proteger la información del cliente es una prioridad principal para PG&E. PG&E trata la información sobre sus clientes, incluida la información personal, como confidencial, de acuerdo con todos los requisitos legales y reglamentarios, incluidos los establecidos por la Comisión de Servicios Públicos de California y otros.
- Durante más de dos décadas, PG&E y otros servicios públicos propiedad de inversionistas en California han estado sujetos a regulaciones muy estrictas de la CPUC que les prohíben divulgar información específica del cliente, como datos de facturación, a terceros sin el consentimiento expreso del cliente.
- Una vez que un cliente autoriza la divulgación de datos, es responsabilidad del cliente y del tercero proteger esos datos.
- Un cliente puede optar por dejar de compartir datos con un tercero en cualquier momento iniciando sesión en su cuenta en línea de PG&E y cancelando su autorización. La política de privacidad completa de PG&E y el Aviso de acceso, recopilación, almacenamiento, uso y divulgación de información sobre el uso de energía están disponibles en pge.com/privacy.
- Dentro del alcance del programa Compartir mis datos, los terceros están sujetos a las Reglas de privacidad y protección de datos del cliente especificadas en los términos y condiciones de la plataforma Compartir mis datos y a los requisitos incluidos en la Tarifa de acceso a datos del cliente.
- Los terceros también están sujetos a todas las demás leyes y reglamentaciones aplicables relacionadas con la protección de la privacidad del cliente, incluidas, entre otras, las Reglas sobre la privacidad y la seguridad para la protección de los datos de uso de energía adoptadas por la CPUC como Anexo D de la Decisión 11-07-056 (Eléctrica), también resumidas en la Regla Eléctrica n.o 27 de PG&E y la Sección 1798.80 – 1798.84 del Código Civil de California.
- Para obtener más información, seleccione los siguientes enlaces:
Términos y condiciones de Compartir mis datos (PDF, 190 KB)
Regla eléctrica n.o 27 (PDF, 1.6 MB)
Anexo D de la decisión 11-07-056 (PDF)
Encuentre más información:Código Civil de California, Sección 1798.80 – 1798.84
- Consulte el enlace a continuación para obtener una lista detallada de los elementos de datos compatibles.
- En ocasiones, faltan datos de uso de intervalo porque nuestros procesos de validación de datos ascendentes descubren que hay lecturas de datos faltantes o incorrectas que pueden requerir un procesamiento adicional (edición o estimación).
- Para los clientes facturados por intervalo (p. ej., clientes con consideraciones de facturación por tiempo de uso), estas instancias se corrigen a tiempo para garantizar un cálculo preciso de la factura en su próxima factura mensual.
- Si desea recibir correcciones de datos, asegúrese de marcar la casilla de verificación Notificarme ya que los datos están listos durante el registro o iniciando sesión en su cuenta en línea y seleccionando esta casilla de verificación en Editar perfil. Luego incluiremos correcciones de datos que hayan sido capturadas por nuestro sistema durante las 24 horas anteriores, como parte de la alimentación de uso diario, para cualquier dato al que esté autorizado a acceder.
- Las correcciones de datos cubrirán cualquier cambio para el período autorizado, hasta un máximo de tres años.
Nota: En consideración de los Proveedores de respuesta a la demanda de la Regla 24 y otros programas que utilizan Compartir mis datos, las correcciones posteriores a los hechos para los rangos de fechas previamente autorizados pueden proporcionarse a terceros durante un máximo de tres años después del vencimiento de la autorización.
- Si corresponde, PG&E enviará notificaciones a su URL de notificación proporcionada durante el registro. Las notificaciones comprenden URL correspondientes a datos ya preenvasados listos para que regrese y solicite en las URL proporcionadas. Los datos están preempaquetados y las notificaciones se envían en los siguientes dos escenarios: (1) ha seleccionado "Notifíqueme ya que los datos están listos" en su perfil de registro, en cuyo caso empaquetaremos los datos diarios más recientes con cualquier corrección para fechas pasadas, o (2) ha realizado una solicitud asincrónica ad hoc anterior para la cual los datos solicitados ahora están listos. El Escenario 1 se ilustra en la sección “DATA ACCESS: SUSCRIPCIÓN DIARIA" de los diagramas de Métodos de acceso a datos en la Página de acceso a datos y el escenario 2 se ilustra en la sección “DATA ACCESS: SOLICITUD DE AD HOC (ASINCRONOSO)" de los mismos diagramas también en la página de acceso a datos.
Acceso a los datos de la visita anterior
- Los datos de uso de electricidad proporcionados por Share My Data no son Datos del Medidor de Calidad de Liquidación (SQMD) según lo especificado por el Operador del Sistema Independiente de California (CAISO). El SQMD se genera multiplicando los datos del medidor de calidad de ingresos (RQMD) por el factor de pérdida de distribución (DLF) aplicable al nivel de voltaje de ese cliente para ese intervalo, convirtiendo los intervalos medidos al período de intervalo requerido por el CAISO y luego sumando los resultados de cada intervalo al nivel agregado requerido por el CAISO.
- PG&E está implementando indicadores del tipo "QualityOfReading" (QOR) proporcionado por el estándar ESPI para comunicar si los datos son de calidad de ingresos. El tipo de QOR captura diferentes valores de calidad posibles para los datos de uso, incluido un valor explícito para “Datos del medidor de calidad de ingresos” o “RQMD”. PG&E utilizará este tipo de QOR en su transmisión de datos de la siguiente manera:
- PG&E admite la clase de “Resumen de uso” proporcionada por ESPI, que se utilizará para identificar las fechas para las cuales se factura un acuerdo de servicio, el monto de uso facturado y la calidad de los datos de uso en el momento de la solicitud. El resumen de uso se completará una vez que la factura esté disponible para los datos solicitados e incluirá dos indicadores (elementos) del tipo QOR:
- El elemento UsageSummary.QualityOfReading (en el nivel UsageSummary) que indica la calidad en el momento de la solicitud de los últimos valores de uso de intervalo proporcionados más las correcciones correspondientes a las fechas UsageSummary.billingPeriod.
- El elemento PredeterminadoCalidad para TotalConsumptionLastPeriod (como parte de UsageSummary.OverallConsumptionLastPeriod.ReadingTypeRef) indica la calidad del uso total facturado.
- PG&E también comunicará la calidad de los datos de uso a nivel de intervalo en el momento de la solicitud utilizando el elemento IntervalReading.ReadingQuality.Quality.
- PG&E admite la clase de “Resumen de uso” proporcionada por ESPI, que se utilizará para identificar las fechas para las cuales se factura un acuerdo de servicio, el monto de uso facturado y la calidad de los datos de uso en el momento de la solicitud. El resumen de uso se completará una vez que la factura esté disponible para los datos solicitados e incluirá dos indicadores (elementos) del tipo QOR:
- Durante el registro, puede seleccionar cuántos datos históricos necesita, ya sea 24, 36 o 48 meses en el menú desplegable "Cuántos datos históricos se solicitan".
- Como parte de la autorización de un cliente que le permite acceder a sus datos, el período histórico de autorización se establecerá de forma predeterminada en su selección de registro para las identificaciones de servicio (puntos de uso) incluidas en la autorización.
- Puede actualizar los datos históricos solicitados iniciando sesión en su cuenta, navegando a Administrar registro > Editar > y seleccionando en el menú desplegable "Cuántos datos históricos se solicitan".
- Tenga en cuenta que los datos proporcionados en la solicitud histórica comenzarán con la fecha en que el cliente realiza la autorización, en lugar de la fecha en que usted realiza la solicitud a la API.
Nota: Los cambios en los datos históricos solicitados solo afectan las autorizaciones de clientes nuevos, mientras que las autorizaciones de clientes anteriores reflejarán su selección en el momento de la autorización.
- Según el estándar ESPI, la respuesta utiliza el estándar de publicación de Atom. Seleccione el enlace a continuación para ver una lista completa de las API compatibles, junto con los elementos de datos disponibles.
- Las identificaciones de servicio eléctrico y de gas activas instaladas y leídas por PG&E son elegibles para autorización a través de la plataforma Share My Data.
- Si la identificación del servicio asociada con una autorización cambia debido a uno de los siguientes motivos, la autorización pasará a la nueva identificación del servicio y continuará el acceso a los datos históricos de uso del intervalo:
- Apagado temporal debido a falta de pagos
- Mover a facturación de intervalo
- Intercambio de medidor
- Cambio de tarifa
- Otros escenarios que resulten en un cambio en la identificación del servicio, como el traslado de ubicaciones o el cambio de una compañía, terminarán el acceso. Además, si una cuenta está desvinculada de su cuenta de My Energy, todas las identificaciones de servicio subyacentes que fueron autorizadas a través de Share My Data no estarán autorizadas como resultado.
- Para determinar la granularidad de los datos de intervalo autorizados, consulte el elemento Longitud del intervalo según lo dispuesto por el estándar de ESPI.
- PG&E proporciona datos de uso de intervalo con la misma granularidad que se recopila para fines de facturación, que generalmente es por hora o 15 minutos para datos eléctricos y diariamente para datos de gas para aquellos clientes con medidores de intervalo. Si bien puede variar según el cliente, el uso del medidor de intervalo eléctrico generalmente está disponible a nivel por hora para la mayoría de los clientes residenciales y a nivel de intervalo de 15 minutos para la mayoría de los clientes comerciales, y el uso del medidor de intervalo de gas generalmente está disponible a nivel diario para la mayoría de los clientes.
- Para los medidores sin intervalo, se proporcionarán datos cuando estén disponibles.
- Para la gran mayoría de los clientes de PG&E con un medidor inteligente instalado, los datos de uso de intervalos eléctricos y de gas están disponibles al final del día siguiente a través de la plataforma Compartir mis datos.
- La pequeña parte de los clientes de electricidad de PG&E con medidores MV90 basados en el portador de líneas eléctricas instalados puede requerir tiempo adicional para que los datos estén disponibles.
- Si bien no podemos respaldar directamente la configuración de sus API, tenemos una serie de recursos disponibles para ayudar a sus recursos técnicos y de TI en el proceso de desarrollo. Consulte nuestra página Documentación de API para obtener más información. También no dude en comunicarse conShareMyData@pge.com si tiene alguna pregunta adicional.
Para obtener más información, visite la interfaz de programación de aplicaciones (API)
Más información sobre SmartMeter
Contáctenos
Si tiene preguntas o comentarios, envíe un correo electrónico a nuestro equipo a ShareMyData@pge.com.
Proveedores de dispositivos
Información para proveedores de dispositivos de red de área doméstica (Home Area Network, HAN).
Lectura de un SmartMeter™
La pantalla del SmartMeter to muestra una flecha que indica si está usando o exportando energía.