.. _api_getting_started:


Getting started
======================

In this chapter, you can find a recommended sequence of steps that will help you harness your system's complete functionality.

.. rubric:: In this chapter:

.. contents::
   :local:


.. tip::
   ``<findface-ip:port>`` must be substituted into your ip address for FindFace Multi.
   ``<token>`` must be substituted into your token.


Gear Up for Work
-----------------------

Perform the primary configuration of your system:

#. :ref:`Deploy FindFace Multi <deployment>` and learn API documentation at ``http://<findface-ip:port>/api-docs``.
#. :ref:`Authorize <HTTP_basic>` with HTTP Basic auth by sending credentials to the login form.
#. :ref:`Create an authorization token <API_Key>` with your session UUID and optionally face authorization.
#. Paste a token into the ``API Key`` field in the authorization form: ``Token <token>`` or put it into the Authorization HTTP header.

Organize Watch Lists and Card Index
---------------------------------------
#. :ref:`Create a new watch list <add_a_new_watch_list>`, using ``POST`` method, or use the default one.
#. :ref:`Find watch list ID <get_watch_lists>` to make a ``POST`` request for :ref:`creating a new card <api_cards>`.
#. Perform :ref:`face (car, body) detection <api_detect>` on the attached photo and copy ``id`` of the necessary object.
#. Attach an image of the individual’s :ref:`face <api_object>`, using ``detection id``.


Upload and Process Video File
---------------------------------
#. Organize Video Surveillance by :ref:`uploading a video file <api_videos>`.
#. Find ``id`` of the video archive by :ref:`listing video archives <list_video_archives>`  or :ref:`adding new one <add_a_new_video_archive>`.
#. :ref:`Attach source video file <attach_source_video_file>` with ``id`` of the video archive.
#. :ref:`Start video archive processing <start_video_archive_processing>`.

Data Sources
------------------------

To configure video-based object monitoring, add cameras to FindFace Multi, grouping them subject to their location.

#. A default preconfigured camera group is available in the system. :ref:`List available camera group <get_camera_groups>`.
#. If necessary, :ref:`create a new camera group <add_a_new_camera_group>`.
#. Use camera group ``id`` to make a ``POST`` request for :ref:`creating a new camera <add_a_new_camera>`.

FindFace Multi in Action
----------------------------------

#. Search for objects in the database of detected objects and card index. :ref:`Learn more <api_search_objects>`.
#. :ref:`Compare two objects <api_compare>` and verify that they match.