Skip to main content
U.S. flag

An official website of the United States government

Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

Setting up your API Account

iEdison

In order to establish an API connection with iEdison, an organization 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 

The user intending to access use the iEdison API is responsible for contacting a certificate provider and procuring a certificate or reusing an existing certificate they may already have. 

NOTE: iEdison supports certificates from multiple certificate providers. A complete list of iEdison supported certificate providers is listed in the API Technical Document available here.

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.

System account screenshot.

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
    Sidebar screenshot.
  2. Click the "Add System Account" button 
    System account screenshot.
  3. Select your agency or Organization from the dropdown menu and provide the Client Name for the system account.
  4. Upload the Certificate and signed ISA document for the account. 
    • Note:  The system will auto-populate the Certificate Information section if the certificate has been successfully uploaded and validated by iEdison.  
  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.

4. Maintain a Valid Certificate

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

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

  1. Navigate to the Manage System Account page
  2. Locate the Vendor Name on the System Account table and click on the View Profile link under the Action Items column 
    System account screenshot.
     
  3. Click on the Upload button for the PKI Certificate to replace the expired certificate
    • The system will validate the certificate and pre-populate the Certificate Information section using the new certificate
  4. Click Save

 

TROUBLESHOOTING

The following table describes common error messages you may receive when setting up your System Account as well as the possible causes and solutions:

Type of Issue Error Message Possible Cause/Solution
Connectivity UnknownHostException The full URL for the Web Service is incorrect. (Verify the URL that is being called.)
Certificate SSLPeerUnverifiedException The certificate has not been obtained or configured properly in the calling program.
Mapping

SOAP response containing a

HTTP 500: “Mapping doesn’t exist for certificate”
Verify that the serial number and authority match the certificate on the caller’s server.
Authorization

SOAP response containing a

HTTP 500: “User <XYZ> is not authorized to access this operation”
 
Expired Certificate

SOAP response containing a

HTTP 500: “Certificate has expired.”
For help resolving this issue, please contact the administrator of the agency or organization.
Inactive Agency/Organization Account

SOAP response containing a

HTTP 500: “Agency/Organization has been disabled.”
The agency or organization has been disabled. (Contact the iEdison Helpdesk if you believe the account needs to be re-activated)
Other Exception SOAP response containing a system exception For help resolving this issue, contact the iEdison Helpdesk with the date/time of the call, serial number, certificate authority, and the name of the Web Service.

 

Created April 20, 2022, Updated July 7, 2022