|
| 1 | +From 872a53cf71e0fbce0889b9557fd64b73b75a042d Mon Sep 17 00:00:00 2001 |
| 2 | +From: Denis Jagoudel < [email protected]> |
| 3 | +Date: Tue, 6 Dec 2016 18:37:20 +0100 |
| 4 | +Subject: [PATCH] Update README |
| 5 | + |
| 6 | +--- |
| 7 | + README.md | 28 ++++++++++++++++++++++++---- |
| 8 | + 1 file changed, 24 insertions(+), 4 deletions(-) |
| 9 | + |
| 10 | +diff --git a/README.md b/README.md |
| 11 | +index 8aa07c9..b3d127d 100644 |
| 12 | +--- a/README.md |
| 13 | ++++ b/README.md |
| 14 | +@@ -1,6 +1,14 @@ |
| 15 | + # idcheckio_python_client |
| 16 | + Check identity documents |
| 17 | + |
| 18 | ++ |
| 19 | ++ |
| 20 | ++Web application : <https://idcheck.io> |
| 21 | ++ |
| 22 | ++Mashape REST API : <https://market.mashape.com/ariadnext/idcheck-io-api> |
| 23 | ++ |
| 24 | ++Swagger REST API : <https://api.idcheck.io/swagger/#/> |
| 25 | ++ |
| 26 | + This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: |
| 27 | + |
| 28 | + - API version: 0.0 |
| 29 | +@@ -12,6 +20,21 @@ This Python package is automatically generated by the [Swagger Codegen](https:// |
| 30 | + |
| 31 | + Python 2.7 and 3.4+ |
| 32 | + |
| 33 | ++**Credentials** |
| 34 | ++ |
| 35 | ++To get your credentials, contact us by email with your all needs at: [email protected] |
| 36 | ++You will receive two sets of credentials: one for test purpose only and on for production. |
| 37 | ++ |
| 38 | ++**Platforms** |
| 39 | ++ |
| 40 | ++Three platforms can be targeted with the library: |
| 41 | ++ |
| 42 | ++| Platform | API URL | Credentials | Purpose | Restriction | Cost | |
| 43 | ++-------------|----------------------------------|-------------|------------------------------------------|----------------------------------------|----------------------| |
| 44 | ++| SANDBOX | https://sandbox.idcheck.io/rest | Test | Dev integration + automated tests | Only a fix set of images are supported | Free |
| 45 | ++| TEST | https://api-test.idcheck.io/rest | Test | Functional tests / Idcheck.io evaluation | No SLA | Commercial agreement |
| 46 | ++| PROD | https://api.idcheck.io/rest | Prod | Production service | None | Commercial agreement |
| 47 | ++ |
| 48 | + ## Installation & Usage |
| 49 | + ### pip install |
| 50 | + |
| 51 | +@@ -24,7 +47,7 @@ pip install git+https://github.com/ariadnext/python-IDCHECKIO.git |
| 52 | + |
| 53 | + Then import the package: |
| 54 | + ```python |
| 55 | +-import idcheckio_python_client |
| 56 | ++import idcheckio_python_client |
| 57 | + ``` |
| 58 | + |
| 59 | + ### Setuptools |
| 60 | +@@ -117,6 +140,3 @@ Class | Method | HTTP request | Description |
| 61 | + |
| 62 | + |
| 63 | + ## Author |
| 64 | +- |
| 65 | +- |
| 66 | +- |
| 67 | +-- |
| 68 | +2.9.3 (Apple Git-75) |
| 69 | + |
0 commit comments