Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 2Set 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. 
Change the default settings and customise it to your brands look and feel. 

Note: You might have already completed this step as part of  'Set up your account' process

Task 3Authenticate

One of the core step in getting  authorised access to Groov's resources.

Task 4Connect

Draft,....

Flow

Draft.....
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 5Make an API call and explore Groov APIsExplore our Groov API suite via Swagger and test your first API call via code. Explore Groov's rich suite of APIs



Anchor
#authenticate
#authenticate
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.

Image Added   Image Added



Anchor
#connect-your-account-via-code
#connect-your-account-via-code
Connect your accounts via code

Groov uses Bearer authentication (also called token a


Anchor
#test-1st-groov-api
#test-1st-groov-api
Call Groov API's

Groov uses Bearer authentication (also called token a





Panel

On this page:

Table of Contents

XXXXX?

a. XXXXX:
YYYYYYY


Related pages

Filter by label (Content by label)
showLabelsfalse
spacesGroovDocs
showSpacefalse
sorttitle
typepage
cqllabel in ( "documentation-space-sample" , "documentation-related" ) and type = "page" and space = "GroovDocs"
labelsdocumentation-space-sample