PV_Live API Capacity Endpoint Update Transitioning To New Methods

As part of our ongoing efforts to enhance the PV_Live API and provide more efficient data access, we are making a significant update to the /capacity endpoint. This article outlines the changes, the timeline, and the recommended actions for users of the Sheffield Solar and PV_Live APIs. This transition ensures a more streamlined and user-friendly experience for accessing PV capacity data, aligning with the other API endpoints and leveraging the benefits of our GCP-hosted infrastructure. Understanding these updates is crucial for developers and researchers who rely on our data for their projects and analyses.

Background and Current Setup

Currently, the /capacity endpoint on the "on-prem" PV_Live API functions by returning a directory listing. This listing contains folders for each PV capacity update, which in turn include a series of compressed files. For instance, you can see this structure at https://api.solar.sheffield.ac.uk/capacity/. The "GCP-hosted" PV_Live API is configured to redirect requests from https://api.pvlive.uk/capacity/ to the aforementioned on-prem endpoint. This setup, while functional, is less streamlined compared to other PV_Live API endpoints, which typically provide JSON responses. The existing structure, with its directory listing and compressed files, can be cumbersome to navigate and process, especially for applications requiring automated data retrieval and parsing. By transitioning to a JSON-based response, we aim to simplify the process and improve the overall user experience. This change also aligns the capacity endpoint with the design principles of the other PV_Live API endpoints, ensuring consistency and ease of use across the platform. The move to GCP hosting further enhances the reliability and scalability of the API, ensuring it can handle increasing demand and deliver data efficiently. The old system, while reliable in its time, lacks the modern efficiencies and scalability that GCP provides, making this update a necessary step forward.

Introducing the New Capacity API Endpoint

To address these limitations, we have developed a new API endpoint that provides capacity data in a more accessible JSON format. This new endpoint is currently available for testing at https://api.solar.sheffield.ac.uk/capacity2/. The JSON format offers several advantages, including ease of parsing and integration with various programming languages and tools. This enhancement is part of our commitment to delivering a more modern and efficient API experience, reducing the complexity involved in accessing and utilizing PV capacity information. The transition to a JSON-based response is a significant improvement, as it allows for easier data handling and integration into various applications. By providing data in a structured format, we are simplifying the workflow for developers and researchers who rely on our API. The new endpoint not only improves the format of the data but also prepares the API for future enhancements and scalability improvements. We encourage users to begin testing the new endpoint to familiarize themselves with the JSON response format and ensure a smooth transition when the old endpoint is decommissioned. This proactive approach will help minimize any disruption to existing workflows and ensure continued access to the critical PV capacity data provided by our API.

Sunset Plan and Key Dates

We have a clear plan for decommissioning the old endpoint and transitioning to the new one. After sunset on Monday, July 7th, 2025, we will implement the following changes:

1. Decommission the old endpoint: https://api.solar.sheffield.ac.uk/capacity/ will be decommissioned.
2. Rename the /capacity2 endpoint: The endpoint currently at https://api.solar.sheffield.ac.uk/capacity2/ will be renamed to https://api.solar.sheffield.ac.uk/capacity/.
3. Remove the redirect: The redirect from api.pvlive.uk/capacity/ to api.solar.sheffield.ac.uk/capacity/ will be removed. Capacity data will then be hosted natively on GCP.

These changes are designed to ensure a seamless transition to the new API structure, providing a more robust and efficient service for accessing PV capacity data. The decommissioning of the old endpoint is a critical step in this process, allowing us to focus resources on maintaining and improving the new system. Renaming the /capacity2 endpoint to /capacity simplifies the API structure and makes it more intuitive for users. The removal of the redirect and native hosting on GCP will improve the reliability and performance of the API. This timeline provides ample time for users to adapt their systems and processes to the new endpoint, minimizing any potential disruptions. We strongly encourage users to start using the new endpoint as soon as possible to ensure a smooth transition and take advantage of the improved data format and accessibility. The clear communication of these dates and changes is essential to ensuring our users are well-prepared and can continue to access the critical PV capacity data they need.

Recommended Actions

We strongly recommend that you begin using https://api.solar.sheffield.ac.uk/capacity/ to access capacity data going forward. This will ensure that your systems are compatible with the new API structure and that you can continue to access the data seamlessly after the transition. The sooner you switch to the new endpoint, the smoother your transition will be, and the more familiar you will become with the new JSON format. This proactive approach will also allow you to take advantage of any performance improvements and new features that may be introduced in the future. Additionally, using the new endpoint provides an opportunity to validate your data processing pipelines and ensure they are compatible with the JSON response. This early adoption will help you avoid any potential issues when the old endpoint is decommissioned and the new endpoint becomes the primary source for PV capacity data. By making this change now, you are investing in the long-term stability and efficiency of your data access workflows. We are committed to supporting our users during this transition and are available to answer any questions or concerns you may have. Your proactive engagement in this process is crucial to ensuring a successful transition and continued access to the valuable PV_Live API data.

On-Prem API as a Test Environment

The on-prem API (https://api.solar.sheffield.ac.uk/) will remain as a test environment. This provides a valuable resource for developers and researchers who want to test their code and ensure compatibility with the PV_Live API without affecting live data. The test environment allows you to experiment with different queries and data processing techniques, ensuring that your applications are robust and reliable. It also provides a safe space to explore new features and functionalities of the API before they are rolled out to the production environment. By maintaining the on-prem API as a test environment, we are reinforcing our commitment to providing a comprehensive and user-friendly platform for accessing PV capacity data. This approach allows for continuous improvement and innovation, ensuring that the API remains a valuable resource for the solar energy community. The test environment is an essential tool for ensuring the quality and reliability of your applications and workflows, and we encourage you to make full use of it as you transition to the new capacity API endpoint. This dedicated test environment underscores our commitment to supporting our users and ensuring they have the tools they need to succeed in leveraging PV_Live API data.

Conclusion

The transition to the new capacity API endpoint is a crucial step in enhancing the PV_Live API and providing a more efficient and user-friendly experience for accessing PV capacity data. By moving to a JSON-based response and leveraging the GCP infrastructure, we are ensuring the long-term reliability and scalability of the API. We urge all users to begin using the new endpoint at https://api.solar.sheffield.ac.uk/capacity/ as soon as possible to ensure a smooth transition before the old endpoint is decommissioned on July 7th, 2025. This update reflects our dedication to continuous improvement and delivering the best possible service to the solar energy research and development community. The benefits of this transition extend beyond just the improved data format; it also includes enhanced performance, scalability, and integration capabilities. We are confident that the new endpoint will provide a superior experience for accessing and utilizing PV capacity data, and we appreciate your cooperation in making this transition a success. Your feedback and engagement are invaluable to us, and we encourage you to reach out with any questions or concerns. Together, we can ensure that the PV_Live API remains a leading resource for solar energy data and research.