v1

latestOpenAPI 3.0.0Apache 2.02026-07-1422655.4 KB
Auth

Create access_token

Exchange an authorization_code for an access-token. The authorization_code is returned in the Connect onSuccess callback after the user successfully submits their utility credentials.

The access_token will not expire. Make sure you securely store it in your database so you can make future requests for the given user.

The fields access_token_expires_in, refresh_token, and refresh_token_expires_in can be ignored. These are included for applications using our legacy authorization framework.

post/auth/token

Headers

Pelm-Client-Idstring required

Your Pelm-Client-Id recieved on registration

Pelm-Secretstring required

Your Pelm-Secret recieved on registration

Response

Successful operation

access_tokenstring
access_token_expires_instring

number of seconds until access_token expires (1 hour)

refresh_tokenstring
refresh_token_expires_instring

number of seconds until refresh_token expires (1 year)