A Python package for interacting with the Identix.one API
- Free software: MIT license
- Package documentation: https://identixone-python.readthedocs.io/
- API documentation: https://kb.identix.one/
- API changelog: https://kb.identix.one/#/apichangelog
- Current supported most recent API version: 1.14.2
- Current stable package version: 0.1.6.3
Install from PyPi using pip, a package manager for Python.
pip install identixone
Don't have pip installed? Try installing it, by running this from the command line:
$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python
Or, you can download the source code (ZIP) for identixone-python, and then run:
python setup.py install
You may need to run the above commands with sudo.
Get your free API token for development at https://identix.one
First of all, specify your API token and API version in Client:
from identixone.api import Client version = 1 token = 'XXX' client = Client(token, version)You can also configure Client using environment variables with prefix IDENTIXONE_ and uppercase key (e.g. TOKEN, VERSION):
from identixone.api import Client os.environ['IDENTIXONE_TOKEN'] = 'XXX' os.environ['IDENTIXONE_VERSION'] = '1' client = Client()Now just make calls using client instance as if you were interacting with HTTP API.
For example, create source:
response = client.sources.create(name='source_name') response.json() # {"id": 1, "name": "source_name", "pps_timestamp": False, ... }Or list some entries with filters:
import datetime date_from = datetime.datetime(year=2019, month=1, day=13, hour=19, minute=20, second=1) date_to = datetime.datetime(year=2019, month=1, day=22, hour=19, minute=20, second=1) r = client.entries.list(date_from=date_from, date_to=date_to) print(r.json()) # {"count": 1, "next": "url", "previous": "url", "results": [{ ... }]}Or even compare two faces how similar they are:
from identixone.base.choices import Conf response = client.utility.compare( photo1, photo2, liveness_photo1=False, liveness_photo2=False, conf=Conf.JUNK) response.json() # {"similar": True, "conf": "ha", "liveness_photo1": False, "liveness_photo2": True}Full examples are inside examples.py file in the root of this repo.
To explore all of the API endpoints visit https://kb.identix.one/
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.