You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-13Lines changed: 23 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Please feel free to reach out
43
43
13)[Version Support](version-support) -
44
44
Extra information on ensuring correct version of Python is being used
45
45
46
-
## An Architectural view
46
+
## An Architectural View
47
47
48
48
Before you start your integration, here is a bit of background on how the integration works. To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens.
49
49
The endpoint can be configured in the Yoti Dashboard when you create/update your application. For more information on how to create an application please check our [developer page](https://www.yoti.com/developers/documentation/#login-button-setup).
@@ -79,7 +79,7 @@ To import the Yoti SDK inside your project, simply run the following command fro
79
79
$ pip install yoti
80
80
```
81
81
82
-
## SDK Project import
82
+
## SDK Project Import
83
83
84
84
You can reference the project URL by adding the following import:
When your application receives a token via the exposed endpoint (it will be assigned to a query string parameter named `token`), you can easily retrieve the user profile by adding the following to your endpoint handler:
118
+
When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for your application.
119
+
This means that if the same individual logs into another app, Yoti will assign her/him a different ID.
120
+
You can use this ID to verify whether (for your application) the retrieved profile identifies a new or an existing user.
@@ -144,7 +154,7 @@ Both example applications utilise the env variables described above, make sure t
144
154
145
155
Plugins for both Django and Flask are in the `plugins/` dir. Their purpose is to make it as easy as possible to use the Yoti SDK with those frameworks. See their respective `README` files for details.
146
156
147
-
## Running the tests
157
+
## Running the Tests
148
158
149
159
Run your project but please make sure you have all the correct requirements:
150
160
@@ -208,7 +218,7 @@ Supporting multiple Python versions with dependencies, often requiring compilati
208
218
209
219
For Python versions that do not provide binary wheels for `cryptography`, it will have to be compiled. This will be done automatically, however, you may need to install development headers of `openssl`.
210
220
211
-
##### On Debian-based systems #####
221
+
##### On Debian-based Systems #####
212
222
213
223
Install `openssl` headers with `apt-get install openssl-dev`
0 commit comments