Developer Portal | Get Started

1. Log in

Do you already have an account with Eaton, that you use to log into www.eaton.com or my.eaton.com? If so, login by following the below instructions.

1. Click Sign In
2. Enter your email address and password
3. Click Sign In.

Signing in will provide you with the ability to view all the published APIs in the  API Specification catalog. Click on the API Specification Catalog on the For Developers page to access the API catalog. You can view the detailed documentation and terms of use for the respective API. In order to request access, please register an app.

If you do not have an existing account, sign up for an Eaton developer account.

1. Click Sign In.
2. Click “Don’t have an account? Sign up”
3. Provide your information and click Register.
4. You will receive a validation email at the email address you provided. Click activate account within that email to validate your email address.

Signing in will provide you with the ability to view all the published APIs in the  API Specification catalog. Click on the API Specification Catalog on the For Developers page to access the API catalog. You can view the detailed documentation and terms of use for the respective API. In order to request access, please register an app.

2. Teams

The purpose of a Team is to group users together in order to grant collective access to an App. Members of that Team will be able to view an Application’s API key(s) and secret(s).

Creating a team

To create a team, follow these steps:

1. Navigate to the Teams page using the link on the For Developers.
2. Click new team
3. Provide the name of the team and an optional description. When choosing a name, it should be clear to the team members what the purpose of this team is.
4. Add the initial team members by providing the members’ email addresses and assigning a role for each.
   1. An owner has full control over the team. They can add or remove members and delete the team, as well as perform the duties of the app admin. This role is appropriate for the individual(s) accountable for the success of the team’s use of APIs.
   2. An app admin can request access to additional apps and create or revoke API keys within the app. This role is appropriate for a technical team lead.
   3. A viewer can view the app and see the credentials within it. This role is appropriate for a developer within a team.
5. Note that it is possible to create the team with just yourself a member. Once the team is created, there will be an option to add team members when viewing the team page.
6. Click the create button.

At any time, you may open the Teams page from the For Developers page  to see the list of Teams. Clicking on a Team provides details such as the list of members and their roles. If the logged-in member of the team has the Owner role, they may also manage other member permissions.

Adding developers to a team

To add new Team members to a Team, a Team Owner should follow these steps:

1. Navigate to the Teams page via the For Developers page.
2. Click on the team that a member should be added to.
3. Click the add member button.
4. Enter additional email-addresses and assign roles as described in the Create a team section.

The individuals that have been granted membership in the team will have access to the team upon signing into the developer portal.

Changing a team member's role

Only an owner of a team can change another member’s role. They may also leave the team, but there must always be at least one owner on the team. The last owner will not be allowed to leave the team.

To change the role of a team member, an owner should follow these steps:

1. Navigate to the Teams page.
2. Click on the drop down next to the member’s name you wish to change and select the desired role.

Removing a team member

Owners of a team can remove members from the Team. This removes their ability to view the team and access any applications that the team is a part of.

To remove a team member, an owner should follow these steps:

1. Navigate to the Teams page.
2. Click on the Remove link next to the member.

3. Register Apps

To get access to an API, please register your application for which the access is requested.

The API product owner will be notified to review the access request.

1. If you intend for the App to be used by a broader team, see the following section, Applications with Teams. If you do not intend for the App to be used by a broader team, then create an App with yourself as the sole owner.
   
2. Open the Apps page by clicking the "Application Access" link on the For Developers page
3. Click new app to create a new app
4. Enter a name and description for the new app
5. Select the API or APIs to which you would like to request access
6. Click request and then save
7. The API key and secret are generated and the product requested access to is pending approval

4. Applications with teams

Adding an application to a team

Applications can be added to Teams by any owner or app admin of the team. Adding an app to a team will allow all members of that team to view the Client ID and API key of the Application.

To add an application to a team, an owner or app admin should follow these steps:

1. Navigate to the Apps page from the For Developers page.
2. Click new app to create a new app
3. Enter a name and description for the new app
4. Select the team as the owner of the app.
5. Select the API or APIs to which you would like to request access
6. Click request and then save

5. Generating an OAuth token

The most common method to authenticate an Eaton API is via an OAuth token. To generate a token, encode your API key and secret using a Base64 encoder. A call to the OAuth token endpoint provides a token that is valid for 1 hour, after which you will have to refresh and create a new one.

If you do not have the API key and secret, please create an app, and request the product you would like to use.

Request URLs:

Adopter: https://api-adopter.eaton.com/oauth/accesstoken?grant_type=client_credentials

Production: https://api.eaton.com/oauth/accesstoken?grant_type=client_credentials

Generate the OAuth token using the following API call, replacing <base64_value> with the Base64-encoded value of the API key and secret in the below format:

<API key>:<secret>

Sample Request

curl -X POST https://api-qa.eaton.com/oauth/accesstoken?grant_type=client_credentials \
-d "" \
-H "Authorization: Basic <base64_value>" \
-H "Content-Type: application/x-www-form-urlencoded"

Sample Response The API returns an OAuth token in the access_token field, as shown in the example response below:

{
"tokenType": "Bearer",
"access_token": "lBrJlbb2ZxLkTGVBeJgcZSrsgTH9",
"issuedAt": 1620839325348,
"expiresIn": 3599,
"clientID": "Aoi5uQe5zDYZB8za4GrVjnNhjUSK8Df2",
"organization_name": "eaton",
"refresh_count": "0",
"refresh_token_expires_in": "0"
}

Please check the authentication requirements for the respective API. If it does not use an external access token received by passing user credentials, you may use the client id that is generated as the API key. This needs to be passed as a header parameter.

api-key: <API key>