.svg)
This article covers the setup, workflow steps, and the Partner Integration API details in GG4L.
In this article
Setup
- A new Vendor gets registered in GG4L Connect.
- GG4L Connect generates OAuth Client ID and Secret.
- GG4L securely delivers Client ID and Secret to a Partner.
Workflow steps
- Use Client ID and Secret to retrieve OAuth access_token (/datahub/oauth/token)
- Use OAuth access_token to call Discovery API
Partner Integration API
GG4L Connect provides an API for retrieving district setup data (including API Client ID and Secret). The API allows for automation of access to roster data of the new customers.
Request:
|
METHOD |
GET |
|
URL |
/datahub/services/vendor/onboarding/credentials |
|
BODY |
empty |
|
HEADERS |
Authorization: bearer {access_token_value} |
Response (on successful authorization):
{
{
"districtName":"abc"
"clientId": "xyz",
"clientSecret":"abc",
"createdTimestamp":"yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"lastDataProcessingCompletedTimestamp":"yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"tokenUrl":"{connect-host}/ep-url",
"apiUrl":"{data-api-host}/ep-url",
"districtGuid":"district GUID",
"expiryDate":"YYYY - MM - dd'T'HH:mm:ss.SSSXXX"
},
{
|
Field |
Type |
Description |
|
districtName |
String |
Name of the district |
|
clientId |
String |
OAuth Client ID (for access to district’s roster data) |
|
clientSecret |
String |
OAuth Client secret (for access to district’s roster data) |
|
createdTimestamp |
Instant |
A timestamp of partner’s application activation for a district |
|
lastDataProcessingCompleteTimestamp |
Instant |
A timestamp of district’s data being ready for consumption for partner’s application (completion of data accessing process) |
|
tokenUrl |
String |
URL of the endpoint to retrieve access token |
|
apiUrl |
String |
A base URL of One Roster API endpoints |
|
districtGuid |
String |
GG4L’s ID of the district that shares data with the Vendor |
|
expiryDate |
Instant |
End date of the data being accessible to Vendor App |