WebView implementation

npm run dev

A local preview will be available at http://localhost:7070.

Your browser will redirect to an error page. This is because you have not provided a Connect token. Ignore this error and continue following this guide.

1. Get bearer token from create-a-bearer-token endpoint.

2. Make a request to create-connect-token to obtain a connect token endpoint.

   Example Request

   Example Response

   curl --request POST \
   --url https://api.flatpeak.com/connect/tariff/token \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json' \
   --data '{
     "connect_web_uri": "http://localhost:7070",
     "callback_uri": "<any service that can receive webhooks>",
     "postal_address": {
       "country_code": "GB"
     }
   }'

On your computer, where you already have FlatPeak connect code running locally, open: http://localhost:7070?fp_cot=cot_***. Replace **cot_ with the connect_token. The resulting URI may look similar to this example:

Connect will present you with a set of pages that will let you share your tariff information. It automatically chooses the best route to discover your tariff based on the availability of provider APIs, data-sharing regulations and frequency of provider use within the FlatPeak base.

Once click Save button on Your Tariff Summary** screen, Connect will send the following to callback_uri you specified:

https://webhook.site/4623e56fc5c1?fp_cot=cot_6587fa4362341be5b524de3b

Once you receive a callback and use connect_token as a reference, call the exchange-connect-token API endpoint to obtain a location_id that represents a permanent identifier of your customer’s address in FlatPeak. Store it in your database as a reference to the physical location of your customer’s property.

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 let them update their tariff connection if necessary.

Customers may need to manually notify you when they change energy providers. They’ll also need a place in your app to take action when you inform them about a tariff connection event received via 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.