Package: identixone
identixone-pythonA Python package for interacting with the Identix.one APIFree software: MIT licensePackage documentation:https://identixone-python.readthedocs.io/API documentation:https://kb.identix.one/API changelog:https://kb.identix.one/#/apichangelogCurrent supported most recent API version:1.14.2Current stable package version:0.1.6.3InstallationInstall from PyPi usingpip, a package manager for
Python.pip install identixoneDon’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 | pythonOr, you candownload the source code
(ZIP)foridentixone-python, and then run:python setup.py installYou may need to run the above commands withsudo.API CredentialsGet your free API token for development athttps://identix.oneGetting StartedFirst of all, specify your API token and API version inClient:fromidentixone.apiimportClientversion=1token='XXX'client=Client(token,version)You can also configureClientusing environment variables with prefixIDENTIXONE_and uppercase key (e.g. TOKEN, VERSION):fromidentixone.apiimportClientos.environ['IDENTIXONE_TOKEN']='XXX'os.environ['IDENTIXONE_VERSION']='1'client=Client()Now just make calls usingclientinstance 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:importdatetimedate_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:fromidentixone.base.choicesimportConfresponse=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 insideexamples.pyfile in the root of this repo.To explore all of the API endpoints visithttps://kb.identix.one/CreditsThis package was created withCookiecutterand theaudreyr/cookiecutter-pypackageproject template.History0.1.6.3 (2019-09-10)Added persons lists module0.1.5 (2019-07-01)Returned entries moduleRemoved records module0.1.4 (2019-06-20)Removed Python 3.4 supportLibrary updated to the new (1.12) API versionRemoved entries moduleFixed places where default values were different than default API values.Fixed several API calls where default values should not be provided.0.1.3 (2019-04-05)Fixed several API calls where default values should not be provided.Fixed places where default values were different than default API values.0.1.2 (2019-04-01)API Changelog is now constantly updated here:https://kb.identix.one/#/apichangelogUpdated documentation to show how to configure client with env variablesRecords endpoints are now deprecatedAdded new Entries and Entries Stats endpoints for RESTful manipulation with data (meant to replace and enhance records functionality)Added new Person Entries endpoint: create new person by providing id of NM entryAdded examples of newly added endpoints0.1.1 (2019-03-16)Updated docstrings for main functionsNew type of exception ImproperlyConfigured that replaces more general error in several placesAdded conf choices where applicableAdded missing methods to bulk delete tokens with filtration (permanent/temporary/both)Added new source optionstore_images_for_confs, introduced in 1.9.0 APIAdded choicesNotificationHTTPMethodof notifications http_method parameter for convenienceUtility compare function now has default conf which equals HA. It reflects now default API behaviourRemoved CHANGES.md because it is redundant. All changes are going to be reflected here, there’s no need to duplicate info.Fixed a bug with env variables (fixed one typo & inability to override vars by setting env variables instead of providing them as parameters to init of Client)Fixed: previously you could provide your own http_client to the Client instance, but it required instance with already supplied token (so you basically needed to provide token in two places). Now you provide only class in http_client and initialization in Client will create instance with provided token for you.0.1.0 (2019-02-18)First release on PyPI.