1
Request your API Credentials
Contact your Account Manager at RABOT or our Integration Management Team to get your API client details.
2
Authenticate using the OAuth 2.0 flow
See our guide for reference. Ensure you have the correct scopes!
Authentication
API authentication & Scopes
3
Query your available Tariffs
As a Sales Affiliate partner using our API, you must first query the tariffs available to your API client in order to generate price quotes and submit orders.
4
Handle the Response
Parse the GET response by deserializing the returned collection of tariff objects and mapping the relevant pricing and tariff attributes to your internal quote or order model.
5
Calculate a price quote
Using your
tariffKey, the lead’s postcode and estimated consumption, make a POST call to generate a price quote6
Submit an Order
Once your lead has accepted the offer and you’ve collected, validated and stored all order data required for order submission, you are ready to submit the order via the POST /orders endpoint!
cURL Request
cURL Request
7
Handle the Response
Parse the response by deserializing the returned
customerNumber and contractNumber and persisting these identifiers in your internal order and customer management systems8
Query the Order Status
Your order has been submitted and is now undergoing validation by RABOT’s platform. Once validated, the order will enter the change process, where communication between energy market partners takes place to locate and process the energy supply request.You can poll our API to track your submitted orders’ status.