Odyssey Standard API Integration

Odyssey Standard API Integration

The Odyssey platform offers multiple ways to integrate mini-grid and solar home system electricity payment data, depending on the data source.  Integrating this data makes it available for the following purposes:

  1.  Enabling the remote verification of connections required by some results-based financing programs.
    1.  To learn more about submitting connections and using remote verification, please refer to the Odyssey user guide.
  2. Enable analytics and visualizations of the data via Odyssey’s Analytics platform, providing insights into the operations across your mini-grid sites or solar home system installations, and joined with other data on the Odyssey platform.
  3. Sharing operating data with other users of the Odyssey platform, such as investors or financing program administrators.
    1. When you share, what you share, and who you share with, is entirely up to you and controllable via the Odyssey Project Sharing User Interface. 

    Integration

    Once you have set up the Odyssey Standard API through the steps listed in our resources here and used the Validator tool to confirm that this is set up correctly,  follow the following steps to create the integration on Odyssey
    1. Navigate to Analytics > Data Integrations from the home page
    2. Click on Create
    3. Add your data set name ( a defining data set name eg Site 1 ( location or name)
    You will see a set of information required to complete the integrations. Fill out all the fields.
    1. Data Provider : Select Odyssey as your data provider
    2. Data Source : Add API as your Data Source
    3. Dataset type : Select the appropriate data set type from the drop down options provided)
    4. Target: Select the appropriate integration target based on requirements
      5. Notes
      If you are integrating your mini-grid data, select the Project-level option.
      If you are integrating distributed assets (i.e. SHS) select the Program-level option.
    5. URL : Add the url you created
    6. API Key : Enter API Key you created
    7. Historical Data StartDate : Select a start date to backfill historical data by clicking the " Integrate Historical Data" Check box.
    8. Historical Data End date : Select an End date to backfill historical data
    Click on Save