.. _api:

IScorE API
==========
In order to better integrate with external applications and make some administrative tasks easier, IScorE has a JSON
API. The browsable API can be found at ``/api/v1``. The API uses Token authentication to protect the private portions of
the API. Tokens can be obtained through the :ref:`API Access <api_access>` portion of the :ref:`user_management` section.

Alternatively, you may use the python shell (``python manage.py shell``) to create a token for a user. To create a token
from the shell, do the following:

>>> from django.contrib.auth.models import User
>>> from rest_framework.authtoken.models import Token
>>> user = User.objects.get(username='<username desiring token>')
>>> token = Token.objects.create(user=user)
>>> print token.key

When making authenticated calls to the API, send an ``Authorization`` header with your token. For example::

   Authorization: Token <TOKEN_HERE>

The API has the following sections:

.. toctree::
   :maxdepth: 2

   services
   teams
   flags
   anomalies
   dns
   settings