Onboarding Material¶
This section contains some references and material that will assist users and integrators onboarding process.
References¶
The definite guide for integrators remains the service OpenAPI Reference.
The codebase is available under EUROPEAN UNION PUBLIC LICENCE v. 1.2 (EUPL v1.2) in our GitHub code repository.
To get a better understanding on features and approaches utilized throughout the HTTP Api interface, you can read about some Api Constructs.
To know more about Api response codes and how to interpret them, you can take a look at the Status & Error Codes.
On aspect pertaining to security, you can read more at the Secruity section.
For an overall view of the service, you can go through the Architecture.
For any questions, you can consult the FAQ.
If you are facing a problem, check if there is a relevant issue answering your question.
You can always contact us through the DataGEMS Help Desk.
Examples¶
You can find here a postman collection that describes some example calls of the Api. You will need to create an environment and define the following variables:
- userAccessToken: set here the access token retrieved from the DataGEMS AAI service
- baseUrl: set this to the api endpoint you want to use
Depending on the access level of the user that was authenticated and whose access token you have placed in the userAccessToken variable, you will be able to utilize the respective endpoints.
The postman collection can be found here: DataGEMS.dg-app-api.postman-collection.json.
Tutorials¶
You can find useful material and onboarding guidelines in our social channels bellow, as well as our platform documentation.
Keep in touch¶
Make sure to follow the DataGEMS channels to get the latest news and references: