Getting Started
Outlined below are 4 key considerations to keep in mind when planning for and making API calls to the Leap endpoints.
1. Leap user account
Your Leap user account credentials are required to log into the following:
- Partner Portal - Can be used to validate data within your account (e.g. connections, meters, dispatch events, performance, revenue). NOTE: your same credentials will work in both Production and Staging.
- Partner Account page - Page within Partner Portal to view/manage API keys, invite new admin users, manage permissions, etc.
- Leap Developer Portal - You can login to this developer portal by clicking the 'Log In' link in the top-right corner and it will automatically populate a temporary bearer token in the CREDENTIALS box of the API Reference endpoint docs so you can make API calls directly from your browser.
- Knowledge Center - View Leap platform guides as well as market and program-specific operational guides.
Getting Access:
Once Leap has created your partner account on the Leap platform, the initial admin users are invited to create their credentials for accessing the platform. See the callout below for managing user access and inviting additional admin users.
Invite Additional Admin Users
Once you have your user account, you can invite additional users and manage their permissions in your Partner Account page. Inviting users in this Production partner account page will automatically give them access to the Staging environment as well.
‘Manager’ role has full admin access whereas the ‘User’ role does not have the ability to manage the account settings (e.g. invite/delete users, create/revoke API keys). When users are added, an automated email is sent with a link to create their password. This link expires after a few days. If this happens, simply delete their account on the Users tab and re-add them.
2. Staging vs. production base URL
Decide whether you want to make a call in the staging or production environments:
- Production: https://api.leap.energy/
- Staging: https://api.staging.leap.energy/
3. Bearer token for authentication
All requests to the Leap API endpoints must include a valid Bearer token in the HTTP Authorization header. See the Authentication (API Keys) guide for more details. These API keys can be created on your Partner Account page in production or staging.
For testing in your browser, see the auto-populated bearer token callout in instruction below.
403 Errors - Production vs. Staging
API keys are scoped to production or staging environments separately so make sure you are creating your key in the appropriate environment in which you want to use it. You will receive a 403 error if the key is invalid.
POST /v2/meters/enrollments/search HTTP/2
Accept-Encoding: gzip
Host: example.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiOWIxODc2YzEtMTk5Yy00ZjRjLWJmYjEtNWZkMTEzM2M1MGJjIiwiYWNjb3VudF9pZCI6ImJjZjc1YWQ3LTE5OWMtMTk1NC1iZmIxLTVmZTExMzNhNTBiYyIsInBlcm1pc3Npb25zIjpbIlJlZ2lzdGVyTWV0ZXIiLCJHZXRNZXRlciIsIkRlbGV0ZU1ldGVyIiwiUGxhY2VCaWQiLCJHZXRCaWQiXSwiZXhwaXJhdGlvbl9kYXRlIjoiMjAxOC0wNy0wOVQxMzoxNjo0N1oifQ.6WQXgno7zU9lrn0IeZYMSoYGNTHUi26m6S5grSGHfEI
4. Submit initial calls from your browser
Choose the endpoint you want to use on the API Reference tab by drilling down in the left panel to see the list of endpoints within each meter journey phase. After selecting an endpoint, the middle panel includes request parameters and response body descriptions. The right panel shows a response example but it also allows you to submit calls using the 'Try It' button.
Simply follow these steps to test from within your browser:
- Under the CREDENTIALS section on the right, add your API key from step #3 above into the Bearer field.
- Under the URL section on the right, choose the Production vs. Staging base URL.
- If applicable or required, enter any QUERY, PATH, or BODY PARAMS in the middle panel.
- Click the ‘ Try It!’ button to see the output in the RESPONSE box at the bottom of the right panel.
Endpoint Example: