Skip to content

Commit 7151467

Browse files
authored
Merge pull request #197 from lumapps/chore/update-docs-index
chore(sdk): update README to reflect new authentication reqs
2 parents 801a4ce + 7fe2ce9 commit 7151467

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Lumapps SDK
22

3-
<p align="center">
3+
<p style="text-align:center">
44
<a href="https://github.com/lumapps/lumapps-sdk/actions?query=workflow%3ACI"><img alt="Action Status" src="https://github.com/lumapps/lumapps-sdk/workflows/CI/badge.svg"></a>
55
<a href="https://pypi.org/project/lumapps-sdk/"><img alt="Pypi" src="https://img.shields.io/pypi/v/lumapps-sdk"></a>
66
<a href="https://codecov.io/gh/lumapps/lumapps-sdk/branch/master"><img alt="Coverage" src="https://codecov.io/gh/lumapps/lumapps-sdk/branch/master/graph/badge.svg"></a>
@@ -9,7 +9,7 @@
99
</p>
1010

1111

12-
LumApps SDK is a set of tools to manipulate the [LumApps API](https://api.lumapps.com/docs/start)
12+
LumApps SDK is a set of tools to manipulate the [LumApps API](https://apiv1.lumapps.com/)
1313

1414
This includes:
1515

@@ -29,25 +29,14 @@ Python >= 3.8
2929

3030
## Getting started
3131

32-
1. Get your token
32+
1. Set up your OAuth application
3333

34-
LumApps supports multiple ways of authentication.
35-
The fastest one to implement is the following:
36-
37-
Get your token by logging to your LumApps account.
38-
Go to [https://sites.lumapps.com](https://sites.lumapps.com) and authenticate.
39-
Once connected, open the javascript console of your browser and run:
40-
41-
```javascript
42-
fetch(window.location.origin+"/service/user/token", {method: "POST"})
43-
.then(data => {return data.json()})
44-
.then(res => {console.log(res.token)});
45-
```
46-
47-
This will generate your personal LumApps token that will be active for 60 minutes, and that we will use in the following steps
34+
Before anything else, you need to set up an OAuth application by following the steps in the [LumApps Developer Portal](https://developer.lumapps.com/documentation/oauth.html).
4835

4936
2. Authenticate
5037

38+
Once your application set up, get a hand on its client ID and secret, then you can write the following
39+
to get an access token for a particular user.
5140
```python
5241
from lumapps.api import BaseClient
5342

0 commit comments

Comments
 (0)