.. _setup_api_key:

Setup API key
=============
To use the Datamint API, you need to setup your API key (ask your administrator if you don't have one).
Use one of the following methods to setup your API key:

Method 1: Command-line tool (recommended)
-------------------------------------------
Run ``datamint-config`` in the terminal and follow the instructions. See :doc:`command_line_tools` for more details.

Method 2: Environment variable
------------------------------
Specify the API key as an environment variable.

.. tabs::

    .. code-tab:: bash

        export DATAMINT_API_KEY="my_api_key"
        # run your commands (e.g., `datamint-upload`, `python script.py`)

    .. code-tab:: python

        import os
        os.environ["DATAMINT_API_KEY"] = "my_api_key"

Method 3: APIHandler constructor
---------------------------------
Specify API key in the |APIHandlerClass| constructor:

.. code-block:: python

    from datamint import APIHandler

    api = APIHandler(api_key='my_api_key')