This documentation is still under development and all instructions are geared towards using Postman as a platform to hit the Lyearn Public API endpoints. However, the Lyearn Public API can be used via any [Platform/Programming Language] like cURL. Although the Lyearn Team plans to provide documentation in other programming languages, currently the documentation only supports using Postman as a tool for hitting endpoints in the [[Lyearn Public API - Prod] Postman Collection]](https://lyearn.notion.site/Lyearn-Public-API-Documentation-Prod-Instance-c900c68ab89e46008d16b13711948d5c) by using the data provided in this documentation.
After downloading, this file can be imported directly in postman as it is. Go to Import → Select Files → Lyearn Public API - PROD.postman_collection.json
The Lyearn Public API is a GraphQL-API which can be used to Create/Read/Update/Delete data on the lyearn database. The data in question can be related to one or many entities mentioned under the Individual Entities section.
An authenticated Access-Token is required to access all endpoints of Lyearn Public API. The Access-Token can be generated by any client that has the client credentials provided by the Lyearn Team.
The authenticated Access-Token can be generated by following the steps mentioned in Authentication with Client Credentials. For using the authenticated Access-Token to access any endpoint related to the Individual Entities, you can refer to Accessing Any Endpoint With Authenticated Access Token.
Automated Authentication process (Suggested if using postman)
Manual Authentication process
Authentication With Client Credentials (Manual Process)
Accessing Any Endpoint With Authenticated Access Token (Manual Process)
Authentication process for Extension
Authentication With Client API Keys
Authentication process for SSO login
Authentication With JWT Based SSO