Tap onto Groovs unified API using the developer tools/kit to access data directly in your application to power up new offerings/propositions for your customers
Getting started for developers
This guide is for our developer community and is an attempt to outline an initial getting started steps that the developer teams need to authenticate a connection with Groov and then explore our unified API.
Sequence | Task | Description |
|---|---|---|
| Task 1 | Register/Sign-up | Setup your institution account with Groov. Note: You might have already completed this step as part of 'Set up your account' process |
| Task 2 | Set your brands look & feel | Your brand is your promise to your customer. and we at Groov understand why its such a key element in integrating any new proposition/product to your current offering. Note: You might have already completed this step as part of 'Set up your account' process |
| Task 3 | Authenticate | One of the core step in getting authorised access to Groov's resources. |
| Task 4 | Connect your accounts | Groov enables Sales data aggregation from your customers Sales and other external accounts. Enable your customers connect their accounts via our CONNECT endpoint or quickly test via our Portal setup using the CONNECT web product. Note: You might have already completed this step via Portal dashboard as part of 'Set up your account - connect your accounts' process |
| Task 5 | Make an API call and explore Groov APIs | Explore our Groov API suite via Swagger and test your first API call via code. Explore Groov's rich suite of APIs |
Authenticate
Groov uses Bearer authentication (also called token authentication) to allows access to its APIs. Bearer Authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request.
The Bearer authentication scheme was originally created as part of OAuth 2.0 in RFC 6750, but is sometimes also used on its own. Similarly to Basic authentication, Bearer authentication should only be used over HTTPS (SSL).
Get your secret key
The client must send the Bearer token in the Authorization header when making requests to Groov's protected resources:
Authorization: Bearer <token>
Your API secret keys can be viewed and copied if you have a Groov account with user role as Administrator or Developer, this has been described in detail in Integration section of this guide, refer to user secret_key. Copy your key before moving to the next step..
Add your secret key to Swagger to Authorise your connection
a. Select Groov API from the documentation links or click here to go to Groov's Swagger section.
b. Select Authorize.
c. Enter the secret key (as copied in the previous step) in the Value field (as per the screenshot below) and authorize your connection. You should see an authorised message which confirms your setup has been successfully authenticated.
Try one of our end point on Swagger
a. Click Ledger Accounts - it will show the endpoints we have enabled for you to know more business information about your customers who are connected to Groov via consent journey. We call your customers 'Ledger accounts' on Groov
b. Select GET /v1/ledgeraccounts to view details about the list all ledger accounts and then click on Try it out option on Swagger.
c. click on Execute (the page field default will be 0)
d. You'll see the API response in the Responses section.
Connect your accounts via code to Sandbox partner
Whilst we are enabling the endpoint for you to call our CONNECT hosted page oAuth API using code, you can always use our Portal dashboard enabled CONNECT web product to setup multiple connections using Sandbox partner setup.Most likely you would have gone through this testing process as detailed in Set up your account - connect your accounts' section.
Call Groov Live API's
Now you are all setup, you have already authorised yourself and have tested a sample API using our Swagger documentation.
Call our API for the first time using code
a. Create a new REST client using https://app.wearegroov.io/api/ as the base URL.
b. Add the secret_key as per above step and connect atleast one test customer using a test/dummy account id to Sandbox
c. Create a GET request for the /ledgeraccounts endpoint and execute the API request..
Retrieve data from all our available APIs
Groov has provides a rich suite of various endpoints associated to your customer connected platform and all is structured with 'ledgeraccount' object as the primary root. The endpoints that have been available till date have been explained in details in our Groov API swagger section.
As an example if you want to query for all the payments associated to your customer (i.e a ledgeraccount on Groov), you should use the GET /v1/payments endpoint with the provisioned input parameters as explained in the documentation.
Groov API Catalogue
Please browse through our catalog to see what we are working towards to over the next few days. Groov API Catalogue
Happy Grooving....
On this page: