Skip to main content    

An official website of the United States government

Here’s how you know

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

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

https://www.nist.gov/iedison/setting-your-api-account

            -  Topics  -  All Topics 
-  Advanced communications 
-  Artificial intelligence 
-  Bioscience 
-  Buildings and construction 
-  Chemistry 
-  Climate 
-  Cybersecurity 
-  Electronics 
-  Energy 
-  Environment 
-  Fire 
-  Forensic science 
-  Health 
-  Information technology 
-  Infrastructure 
-  Manufacturing 
-  Materials 
-  Mathematics and statistics 
-  Metrology 
-  Nanotechnology 
-  Neutron research 
-  Performance excellence 
-  Physics 
-  Public safety 
-  Resilience 
-  Standards 
-  Transportation 
 
            -  Publications 
            -  Labs & Major Programs  -  Laboratories    -  Communications Technology Laboratory 
  -  Engineering Laboratory 
  -  Information Technology Laboratory 
  -  Material Measurement Laboratory 
  -  Physical Measurement Laboratory 
-  User Facilities    -  NIST Center for Neutron Research 
  -  CNST NanoFab 
-  Research Test Beds 
-  Research Projects 
-  Tools & Instruments 
-  Major Programs    -  Baldrige Performance Excellence Program 
  -  CHIPS for America Initiative 
  -  Manufacturing Extension Partnership (MEP) 
  -  Office of Advanced Manufacturing 
  -  Special Programs Office 
  -  Technology Partnerships Office 
 
            -  Services & Resources  -  Standards and Measurements    -  Calibration Services 
  -  Laboratory Accreditation (NVLAP) 
  -  Quality System 
  -  Standard Reference Materials (SRMs) 
  -  Standards.gov 
  -  Time Services 
  -  Office of Weights and Measures 
-  Software 
-  Data    -  Chemistry WebBook 
  -  National Vulnerability Database 
  -  Physical Reference Data 
  -  Standard Reference Data (SRD) 
-  Storefront 
-  License & Patents 
-  Computer Security Resource Center (CSRC) 
-  NIST Research Library 
 
            -  News & Events  -  News 
-  Events 
-  Blogs 
-  Feature Stories 
-  Awards 
-  Video Gallery 
-  Image Gallery 
-  Media Contacts 
 
            -  About NIST  -  About Us    -  Leadership 
  -  Organization Structure 
  -  Budget & Planning 
-  Contact Us 
-  Visit 
-  Careers    -  Student programs 
-  Work with NIST 
-  History    -  NIST Digital Archives 
  -  NIST Museum 
  -  NIST and the Nobel 
-  Educational Resources 
 

## iEdison

-  About iEdison 
-  Frequently Asked Questions 
-  Outages & Updates 
-  Registering with iEdison 
-  iEdison User Guides  Expand or Collapse    -  Organization User Guide 
  -  Agency User Guide 
  -  Other Guidance Documents 
-  Training Opportunities 
-  Video Tutorials 
-  iEdison API  Expand or Collapse    -  Setting Up Your API 
  -  API Error Troubleshooting 
-  Agency Contact List 

# Setting up your API Account

## Share

Facebook

Linkedin

Twitter

Email

**In order to establish an API connection with iEdison, an organization must:**
                  - Procure a Certificate
                  -  Sign an Interconnection Security Agreement (ISA)
                  - Create an iEdison System Account
                  - 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.

## 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:
                  - Inside the iEdison application, click **"Manage System Account"** under **"Manage Profiles"** on the sidebar menu  
                  - Click the "Add System Account" button 	        
                  - Select your agency or Organization from the dropdown menu and provide the Client Name for the system account.
                  - 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.  
                  - 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.
                  - 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:
                  - Navigate to the Manage System Account page
                  - Locate the Vendor Name on the System Account table and click on the View Profile link under the Action Items column    
                  - 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
                  - 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:

### HEADQUARTERS

301-975-2000

Webmaster | Contact Us | Our Other Offices

TwitterFacebookLinkedInInstagramYouTubeGiphyRSS FeedMailing List

Feedback

            -  Site Privacy 
            -  Accessibility 
            -  Privacy Program 
            -  Copyrights 
            -  Vulnerability Disclosure 
            -  No Fear Act Policy 
            -  FOIA 
            -  Environmental Policy 
            -  Scientific Integrity 
            -  Information Quality Standards 
            -  Commerce.gov 
            -  Science.gov 
            -  USA.gov 
            -  Vote.gov