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

Request

Base URL
https://api.pelm.com
Auth
none declared. Required headers: Pelm-Client-Id, Pelm-Secret
TypeScript
https://skmtc.dev/pelm/apis/pelm-api/docs/auth/token/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Pelm-Client-Idstring required

Your Pelm-Client-Id recieved on registration

Pelm-Secretstring required

Your Pelm-Secret recieved on registration

Request body application/x-www-form-urlencoded

codestring required

authorization code from Connect.

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)

Changes

No recorded changes to this operation across all 1 revision of this API.