Child pages
  • Solargis API User Guide

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Data Delivery Web Service - the main service for accessing Solargis time series data. Both request and response is an XML document. The request parameters (XML elements and attributes) are formally described by XML Schema Definition documents (XSD). By using the schema, request or response can be verified programmatically. For this service, we provide two architectural styles, the REST-like endpoint, and SOAP endpoint. Look for more technical information here.  Authentication and billing is based on API key registered with the user. Please contact us to discuss details, set up trial or ask for a quotation.
  • pvPlanner Web Service - this simple web service provides monthly long-term averaged data (including yearly value) of PV, solar and meteorological data with global coverage. The service is targeted for prospection and pre-feasibility. Sending an XML request mimics the click on the Calculate button in the interactive Solargis pvPlanner application. Request and response for the service is not described in this user guide. More information can be found here.

Additionally, we provide an FTP data delivery service where the request (CSV file) is stored in the user's FTP directory. The service is then scheduled to deliver CSV response files regularly. Request processing is asynchronous - the client creates the CSV request, the server processes the request according to schedule (e.g., 4x per day, every hour), the client then checks for the response files. The CSV request allows for multiple locations in one file. For pricing and setting up a trial FTP user account, please contact us.

...

The client (most often a computer) will send the XML request and waits for the XML response. Users can test web services directly from the web browser by using e.g. REST Client for Firefox or via a native application like Postman. Before sending requests user must set the HTTP Method to "POST", define endpoint URL to https://solargis.info/ws/rest/datadelivery/request?key=demo and also set a header to "Content-Type: application/xml". Then use the XML request examples below and send them in the body of the HTTP request and explore XML responses. Typically, developers will create client code to send requests and handle responses scheduled in time. For all technicalities visit this link. In the next section, there is a description of XML requests with examples. They can serve as starter templates for most typical scenarios.

...