1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
%global _empty_manifest_terminate_build 0
Name: python-alice-onboarding
Version: 1.13.0
Release: 1
Summary: Alice Onboarding Python SDK
License: Alice Copyright
URL: https://github.com/alice-biometrics/onboarding-python
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/b8/f8/a2f2a27d4983d70c0b32f7d5f9c9951cf648e7b14498d3af437d189f9d40/alice-onboarding-1.13.0.tar.gz
BuildArch: noarch
Requires: python3-pyjwt
Requires: python3-pydantic
Requires: python3-requests
Requires: python3-meiga
%description
# onboarding-python <img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/python.png?raw=true" width="30">
[](https://github.com/alice-biometrics/onboarding-python/releases) [](https://docs.alicebiometrics.com/onboarding/sections/server/server_side_sdks/python.html)
<img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/alice_header.png?raw=true" width=auto>
The aim of this Python package is to manage the authentication and backend operations against Alice Onboarding API.
If you want more information about how to integrate with Alice technology, please contact us at support@alicebiometrics.com.
## Requirements
Python 3.7+
## Installation :computer:
```console
pip install alice-onboarding
```
## Getting Started 📈
#### Config
Configure your credentials with *Config* class
```
from alice import Config
config = Config(api_key=given_valid_api_key)
```
#### Onboarding
To manage the operations with Alice Onboarding API, use *Onboarding* class.
This class deals with authentication automatically.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding.py
```
see onboarding example [here](examples/onboarding.py)
## Authentication 🔐
To manage authorization and token creations, use *Auth* class.
Available tokens:
| Type Token | Info |
| ----------------------- |:-------------:|
| BACKEND_TOKEN | Used to secure global requests.|
| BACKEND_TOKEN_WITH_USER | Used to secure global requests include user_id information embedded |
| USER_TOKEN | Used to secure requests made by the users on their mobile devices or web clients.|
To create a BACKEND_TOKEN_WITH_USER and a USER_TOKEN you will need a valid user_id obtained from Alice Onboarding API.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/auth.py
```
see auth example [here](examples/auth.py)
#### Sandbox (Only for early stages of integration)
To manage the operations with the Sandbox API, use *Sandbox* class.
```console
export ONBOARDING_SANDBOX_TOKEN="<YOUR-SANDBOX-TOKEN>"
python examples/sandbox.py
```
see sandbox example [here](examples/sandbox.py)
## Advanced features 🎩
⚠️ These features could not be available by default. If you obtain a HTTP Error (405 method not allowed). Please, contact us to make them available for your credentials.
#### Certified Onboarding
If you need certify your user data, you can retrieve a certified Pdf Report with these feature.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_certificate.py
```
see certified onboarding usage [here](examples/onboarding_with_certificate.py)
#### User Screening
Alice Onboarding API bring us the opportunity of screening a user over different databases & lists (sanctions, PEP, etc)..
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_screening.py
```
see screening onboarding usage [here](examples/onboarding_with_screening.py)
#### Webhooks
Configure your webhooks through the api with the `Webhooks` object.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_webhooks.py
```
see onboarding webhooks usage [here](examples/onboarding_with_webhooks.py)
Note: You can configure your webhooks using the Onboarding dashboard.
## Documentation 📄
For more information about Alice Onboarding: https://docs.alicebiometrics.com/onboarding/
## Contact 📬
support@alicebiometrics.com
%package -n python3-alice-onboarding
Summary: Alice Onboarding Python SDK
Provides: python-alice-onboarding
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-alice-onboarding
# onboarding-python <img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/python.png?raw=true" width="30">
[](https://github.com/alice-biometrics/onboarding-python/releases) [](https://docs.alicebiometrics.com/onboarding/sections/server/server_side_sdks/python.html)
<img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/alice_header.png?raw=true" width=auto>
The aim of this Python package is to manage the authentication and backend operations against Alice Onboarding API.
If you want more information about how to integrate with Alice technology, please contact us at support@alicebiometrics.com.
## Requirements
Python 3.7+
## Installation :computer:
```console
pip install alice-onboarding
```
## Getting Started 📈
#### Config
Configure your credentials with *Config* class
```
from alice import Config
config = Config(api_key=given_valid_api_key)
```
#### Onboarding
To manage the operations with Alice Onboarding API, use *Onboarding* class.
This class deals with authentication automatically.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding.py
```
see onboarding example [here](examples/onboarding.py)
## Authentication 🔐
To manage authorization and token creations, use *Auth* class.
Available tokens:
| Type Token | Info |
| ----------------------- |:-------------:|
| BACKEND_TOKEN | Used to secure global requests.|
| BACKEND_TOKEN_WITH_USER | Used to secure global requests include user_id information embedded |
| USER_TOKEN | Used to secure requests made by the users on their mobile devices or web clients.|
To create a BACKEND_TOKEN_WITH_USER and a USER_TOKEN you will need a valid user_id obtained from Alice Onboarding API.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/auth.py
```
see auth example [here](examples/auth.py)
#### Sandbox (Only for early stages of integration)
To manage the operations with the Sandbox API, use *Sandbox* class.
```console
export ONBOARDING_SANDBOX_TOKEN="<YOUR-SANDBOX-TOKEN>"
python examples/sandbox.py
```
see sandbox example [here](examples/sandbox.py)
## Advanced features 🎩
⚠️ These features could not be available by default. If you obtain a HTTP Error (405 method not allowed). Please, contact us to make them available for your credentials.
#### Certified Onboarding
If you need certify your user data, you can retrieve a certified Pdf Report with these feature.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_certificate.py
```
see certified onboarding usage [here](examples/onboarding_with_certificate.py)
#### User Screening
Alice Onboarding API bring us the opportunity of screening a user over different databases & lists (sanctions, PEP, etc)..
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_screening.py
```
see screening onboarding usage [here](examples/onboarding_with_screening.py)
#### Webhooks
Configure your webhooks through the api with the `Webhooks` object.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_webhooks.py
```
see onboarding webhooks usage [here](examples/onboarding_with_webhooks.py)
Note: You can configure your webhooks using the Onboarding dashboard.
## Documentation 📄
For more information about Alice Onboarding: https://docs.alicebiometrics.com/onboarding/
## Contact 📬
support@alicebiometrics.com
%package help
Summary: Development documents and examples for alice-onboarding
Provides: python3-alice-onboarding-doc
%description help
# onboarding-python <img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/python.png?raw=true" width="30">
[](https://github.com/alice-biometrics/onboarding-python/releases) [](https://docs.alicebiometrics.com/onboarding/sections/server/server_side_sdks/python.html)
<img src="https://github.com/alice-biometrics/custom-emojis/blob/master/images/alice_header.png?raw=true" width=auto>
The aim of this Python package is to manage the authentication and backend operations against Alice Onboarding API.
If you want more information about how to integrate with Alice technology, please contact us at support@alicebiometrics.com.
## Requirements
Python 3.7+
## Installation :computer:
```console
pip install alice-onboarding
```
## Getting Started 📈
#### Config
Configure your credentials with *Config* class
```
from alice import Config
config = Config(api_key=given_valid_api_key)
```
#### Onboarding
To manage the operations with Alice Onboarding API, use *Onboarding* class.
This class deals with authentication automatically.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding.py
```
see onboarding example [here](examples/onboarding.py)
## Authentication 🔐
To manage authorization and token creations, use *Auth* class.
Available tokens:
| Type Token | Info |
| ----------------------- |:-------------:|
| BACKEND_TOKEN | Used to secure global requests.|
| BACKEND_TOKEN_WITH_USER | Used to secure global requests include user_id information embedded |
| USER_TOKEN | Used to secure requests made by the users on their mobile devices or web clients.|
To create a BACKEND_TOKEN_WITH_USER and a USER_TOKEN you will need a valid user_id obtained from Alice Onboarding API.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/auth.py
```
see auth example [here](examples/auth.py)
#### Sandbox (Only for early stages of integration)
To manage the operations with the Sandbox API, use *Sandbox* class.
```console
export ONBOARDING_SANDBOX_TOKEN="<YOUR-SANDBOX-TOKEN>"
python examples/sandbox.py
```
see sandbox example [here](examples/sandbox.py)
## Advanced features 🎩
⚠️ These features could not be available by default. If you obtain a HTTP Error (405 method not allowed). Please, contact us to make them available for your credentials.
#### Certified Onboarding
If you need certify your user data, you can retrieve a certified Pdf Report with these feature.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_certificate.py
```
see certified onboarding usage [here](examples/onboarding_with_certificate.py)
#### User Screening
Alice Onboarding API bring us the opportunity of screening a user over different databases & lists (sanctions, PEP, etc)..
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_screening.py
```
see screening onboarding usage [here](examples/onboarding_with_screening.py)
#### Webhooks
Configure your webhooks through the api with the `Webhooks` object.
```console
export ONBOARDING_API_KEY="<YOUR-API-KEY>"
python examples/onboarding_with_webhooks.py
```
see onboarding webhooks usage [here](examples/onboarding_with_webhooks.py)
Note: You can configure your webhooks using the Onboarding dashboard.
## Documentation 📄
For more information about Alice Onboarding: https://docs.alicebiometrics.com/onboarding/
## Contact 📬
support@alicebiometrics.com
%prep
%autosetup -n alice-onboarding-1.13.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-alice-onboarding -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 1.13.0-1
- Package Spec generated
|
