API key
=======

One of the YumiSign platform API authorization method is based on API Key.
To get an API Key, please contact ``info@yumisign.com``.

Generation
----------
First, you need to login to your YumiSign account,
then you go to your manage account, under the Developers section you will be able to manage everything related to your API key.


To generate a new key, you need to click on New API key button then you will enter an API Key name, and select an organization member,
``API Key is always linked to an organization member, to be able to determine who is creating project using it``.

Finally when you click Create, you will have your API Key displayed once, and this is the only time that it will be ever displayed,
so you need to copy/store it somewhere safe, otherwise you will have to delete it and regenerate a new one.

How to use API key
------------------

To use your API Key through API, you need to send ``X-YumiSign-Api-Key`` header on your request.

Example
"""""""

.. code-block:: bash

    curl --request GET 'https://app.yumisign.com/api/v1/examples' \
        --header 'X-YumiSign-Api-Key: MY_YUMISIGN_API_KEY'


Response headers
----------------

In addition to the standard response headers, API responses include the following headers when the request uses an Api Key.

+--------------------------------+------------------------------------------------------------------+
| Header                         | Description                                                      |
+================================+==================================================================+
| X-YumiSign-RateLimit-Limit     | The maximum number of API requests you can make in 30 seconds.   |
+--------------------------------+------------------------------------------------------------------+
| X-YumiSign-RateLimit-Remaining | The number of API requests left before you reach the rate limit. |
+--------------------------------+------------------------------------------------------------------+
| X-YumiSign-CallLimit-Remaining | The number of API requests left before you reach the limit.      |
+--------------------------------+------------------------------------------------------------------+