This section describes how to access an endpoint in the [Lyearn Public API - Prod] postman collection with an authenticated Access-Token. If you do not have an authenticated Access-Token, generate one by following the steps on Authentication With clientid and clientSecret Through Postman page.
<aside>
💡 The steps described below use the Users
→ Get Users
endpoint as an example. However, the process will be similar for accessing all other endpoints. The Request Path for this particular request will be Users → Get Users
</aside>
To access any endpoint, [Users → Get Users in this case], you will need to add the authenticated Access-Token in the Header of that request.
1.1 Go to Request Path → Headers and add the Authorization
: Bearer <Access Token>
as a Key-Value pair as shown in the reference image below. Make sure to add the word Bearer
before pasting your access token.
To execute a request after you have authenticated it with an Access-Token, you will need to add the GraphQL/JSON Query/Mutation and its corresponding GraphQL-variables in the Body Section. [Users → Get Users → Body → GraphQL] in this case. You can find the corresponding Query/Mutation/Request
and its GraphQL-variables
for all endpoints of the [Lyearn Public API - Prod] postman collection in the Lyearn Public API - [Prod Instance] Notion Documentation.