Native API implementation

Your customer begins by clicking a “Connect My Tariff” button (or similarly named control) in your app.

Your app should then:

• Call the create-connect-token endpoint to generate a connect_token.
• Use the token to start a new session by calling the session_restore API route.

Once the session starts, your app will receive one of fifteen possible Connect “Page Objects”. Each object contains all the necessary information to render a page that guides the customer through the next step in tariff discovery process.

For each page:

• Your app captures the user’s input.
  • Submits the response to the Connect endpoint.
  • Receives the next Page Object to render the next step.

Connect dynamically determines the next page based on the customer’s previous responses and returns a corresponding page object. This process continues until Connect determines the session is complete.

Once the customer’s tariff is successfully connected:

• Connect returns a special session_complete object.
• A webhook is triggered to notify your backend systems that:
  • The session is complete
• You can now exchange the connect_token for a permanent location_id that represents a property address.

After your customer completes the Connect flow, FlatPeak will automatically keep their tariff information up to date. If any action is required from the customer, FlatPeak will generate an event. You should subscribe to these events via webhooks and implement a communication flow to notify your customers and guide them through the necessary steps (below).

Customers may wish to modify their tariff settings from time to time or when you notify them of a detected change (webhook). To support these scenarios, follow the Building a tariff settings page in your app guide to add controls that let them update or reconnect their energy account.