documentation/general/unsplash/unsplash_access_key.rst

=======================================================
How to generate an Unsplash access key
=======================================================

.. tip::
  **As an SaaS user**, you are ready to use Unsplash. You won't need to follow this guide to set up Unsplash informations, since you will use our own Odoo Unsplash key in a transparent way.

Generate an Unsplash access key for **non-Saas** users
======================================================

- Create an account on `Unsplash.com <https://unsplash.com/join>`_.

- Go to your `applications dashboard <https://unsplash.com/oauth/applications>`_ and click on **New Application**.

.. image:: media/create_app.png
    :align: center

- Accept the conditions and click on **Accept terms**.

.. image:: media/accept_terms.png
    :align: center

- You will be prompted to insert an **Application name** and a **Description**. Please prefix your application name by "**Odoo:** " so that Unsplash can recognize it as an Odoo instance. Once done, click on **Create application**.

.. image:: media/app_infos.png
    :align: center

- You should be redirected to your application details page. Scroll down a bit to find your **access key**.

.. image:: media/access_key.png
    :align: center

.. warning::
  **As a non-SaaS user**, you won't be able to register for a production Unsplash key and will be limited to your test key that has a restriction of 50 Unsplash requests per hour.

.. seealso::
    * :doc:`unsplash_application_id`
[ADD] Unsplash: Documentation to retrieve access key & app id 2018-10-26 22:27:59 +07:00			`=======================================================`
			`How to generate an Unsplash access key`
			`=======================================================`

[IMP] unsplash: new guidelines negociated with Unsplash Unsplash CEO asked us to stop exposing our key client side (even if it was only in the browser network and allowed by Unsplash API team leader). Also, all our Odoo instance, on premise or not should share the same production key, which is not possible for us obviously. After multiple exchange, it has been negociated that: 1. Our non saas user won't be able to apply for a production key and should prefix they Unsplash application name by 'Odoo:'. Their key will remain in test mode. Indeed, Unsplash won't be able to review every Odoo application and ensure it respects the API terms and it is a real application. 2. Our saas user will query Unsplash server side so the key remain hidden. 3. The documentation should explain it all 2018-11-19 16:44:41 +07:00			`.. tip::`
[FIX] general: correct unsplash page grammar Closes odoo/documentation-user#364 2019-07-04 23:39:03 +07:00			`As an SaaS user, you are ready to use Unsplash. You won't need to follow this guide to set up Unsplash informations, since you will use our own Odoo Unsplash key in a transparent way.`
[IMP] unsplash: new guidelines negociated with Unsplash Unsplash CEO asked us to stop exposing our key client side (even if it was only in the browser network and allowed by Unsplash API team leader). Also, all our Odoo instance, on premise or not should share the same production key, which is not possible for us obviously. After multiple exchange, it has been negociated that: 1. Our non saas user won't be able to apply for a production key and should prefix they Unsplash application name by 'Odoo:'. Their key will remain in test mode. Indeed, Unsplash won't be able to review every Odoo application and ensure it respects the API terms and it is a real application. 2. Our saas user will query Unsplash server side so the key remain hidden. 3. The documentation should explain it all 2018-11-19 16:44:41 +07:00
			`Generate an Unsplash access key for non-Saas users`
			`======================================================`

[ADD] Unsplash: Documentation to retrieve access key & app id 2018-10-26 22:27:59 +07:00			- Create an account on `Unsplash.com <https://unsplash.com/join>`_.

			- Go to your `applications dashboard <https://unsplash.com/oauth/applications>`_ and click on New Application.

			`.. image:: media/create_app.png`
			`:align: center`

			`- Accept the conditions and click on Accept terms.`

			`.. image:: media/accept_terms.png`
			`:align: center`

[FIX] general: correct unsplash page grammar Closes odoo/documentation-user#364 2019-07-04 23:39:03 +07:00			`- You will be prompted to insert an Application name and a Description. Please prefix your application name by "Odoo: " so that Unsplash can recognize it as an Odoo instance. Once done, click on Create application.`
[ADD] Unsplash: Documentation to retrieve access key & app id 2018-10-26 22:27:59 +07:00
			`.. image:: media/app_infos.png`
			`:align: center`

			`- You should be redirected to your application details page. Scroll down a bit to find your access key.`

			`.. image:: media/access_key.png`
			`:align: center`

[IMP] unsplash: new guidelines negociated with Unsplash Unsplash CEO asked us to stop exposing our key client side (even if it was only in the browser network and allowed by Unsplash API team leader). Also, all our Odoo instance, on premise or not should share the same production key, which is not possible for us obviously. After multiple exchange, it has been negociated that: 1. Our non saas user won't be able to apply for a production key and should prefix they Unsplash application name by 'Odoo:'. Their key will remain in test mode. Indeed, Unsplash won't be able to review every Odoo application and ensure it respects the API terms and it is a real application. 2. Our saas user will query Unsplash server side so the key remain hidden. 3. The documentation should explain it all 2018-11-19 16:44:41 +07:00			`.. warning::`
[FIX] general: correct unsplash page grammar Closes odoo/documentation-user#364 2019-07-04 23:39:03 +07:00			`As a non-SaaS user, you won't be able to register for a production Unsplash key and will be limited to your test key that has a restriction of 50 Unsplash requests per hour.`
[FIX] unsplash: fine-tune the doc to fit exactly last changes Countinuity of 7d16eb9619f41c20bd591ff10fe249a33d31d520 2018-11-22 20:26:58 +07:00
			`.. seealso::`
			* :doc:`unsplash_application_id`