Setting up your API Account

In order to establish an API connection with iEdison, an Agency or Organization administrator must: 

1. Procure a Certificate
2. Sign an Interconnection Security Agreement (ISA)
3. Create an iEdison System Account
4. Maintain a valid Certificate

1. Procure a Certificate 

To access REST API services, a system account and a valid NIST-issued PKI client certificate are required.

The Agency or Organization administrator generates a Certificate Signing Request (CSR) during the registration process, with its public key and identifying details, then submits the registration request.  There are instructions on how to generate a CSR in the system account registration page. NIST reviews and verifies the information, and upon validation, signs the certificate to finalize the issuance.

Credit: iEdison

2.  Sign an Interconnection Security Agreement (ISA)

An ISA document is required when creating a system account.  When creating an account, the applicant must download a copy of the ISA document, sign it, and then upload the signed copy during the registration process.

The ISA document can be found here or on the "Manage System Account" page in the iEdison application.

Credit: iEdison

3. Create an iEdison System Account

An agency or organization is required to have a System Account User role to access the iEdison API. Before creating a system account, ensure you have the following prepared to upload and add during the account creation: a valid certificate, an executed ISA document, and a contact person.

Complete the following steps to create your iEdison System Account:

1. Inside the iEdison application, click "Manage System Account" under "Manage Profiles" on the sidebar menu. 

   

2. Click the "Add System Account" button.  

   
3. Select your Agency or Organization from the dropdown menu and provide the Client Name for the system account.
4. Upload the CSR and signed ISA document for the account.
5. Complete the Contact Person section of the registration. Use the radio button to select between the options:
   • Existing Contact: Person designated as Contact Person for your agency or organization.
   • New Contact: New contact person for the system account.
   • My Profile: Designated yourself as the Contact Person for the system account.
6. Click on the Submit button.  

An iEdison Approver user will review your registration and Approve or Deny your System Account registration. You will receive a notification once it is submitted and when the certificate is uploaded.

4. Maintain a Valid Certificate

Once a System Account registration has been approved by an iEdison Approver, agencies or organizations will be able to Create or Update an iEdison report using the iEdison API. Organization and Agency administrators will be responsible for maintaining a valid certificate.

To update an expired or expiring certificate of a System Account, follow the steps below:

1. Navigate to "Manage System Account" under "Manage Profiles" in the Sidebar Main Menu.

2. Locate the Organization Name on the System Account table and click on the View Profile link under the Action Items column.  

   

    

3. Generate a new CSR and click Upload.
4. Click Save.

You will receive a notification once it is submitted and when the certificate is uploaded.