diff --git a/docs/application/profile/index.rst b/docs/application/profile/index.rst index 97dd8f9..ce1d63f 100644 --- a/docs/application/profile/index.rst +++ b/docs/application/profile/index.rst @@ -1,3 +1,5 @@ +.. _profile: + Profile ******* diff --git a/docs/more/development/api.rst b/docs/more/development/api.rst index 452792f..b5676b5 100644 --- a/docs/more/development/api.rst +++ b/docs/more/development/api.rst @@ -1,6 +1,6 @@ -********************************* -Application Programming Interface -********************************* +******************* +Integration via API +******************* An Application Programming Interface (API) allows machines, such as other systems and tools, to perform actions and transfer data based on agreed-upon methods. @@ -20,7 +20,7 @@ While several public endpoints are accessible without authentication, most endpo Example ======= -After obtaining your authentication token and reviewing the API documentation, you can start making API calls to execute actions and transfer data, easily integrating them into your projects. Here's a simple example using the Requests library in Python: +After obtaining your authentication token and reviewing the API documentation, you can start making API calls to execute actions and transfer data, easily integrating them into your projects. Here's a simple example using the `Requests library in Python `__: .. code-block:: diff --git a/docs/more/development/document-templates/tdk.rst b/docs/more/development/document-templates/tdk.rst index 886835f..12a8b6d 100644 --- a/docs/more/development/document-templates/tdk.rst +++ b/docs/more/development/document-templates/tdk.rst @@ -70,8 +70,8 @@ Environment variables and .env file You can use environment variables to authenticate: -* ``DSW_API_URL`` = URL of |project_name| API with which you want to communicate. Hover mouse over your profile name to find the About section where URL is specified. -* ``DSW_API_KEY`` = your API Key. Hover mouse over your profile name, click on :guilabel:`Edit Profile` and then navigate to :guilabel:`API Keys` From there, you can generate a new API Key for the authentication. +* ``DSW_API_URL`` = URL of |project_name| API with which you want to communicate. Hover mouse over your profile name to find the :ref:`About` section where URL is specified. +* ``DSW_API_KEY`` = your :ref:`API Key`. Hover mouse over your profile name, click on :guilabel:`Edit Profile` and then navigate to :guilabel:`API Keys` From there, you can generate a new API Key for the authentication. To make this even easier, you can store those in ``.env`` file in the project root and it will be loaded automatically. Or you can specify the path to a ``.env`` file: diff --git a/docs/more/development/index.rst b/docs/more/development/index.rst index ee99e50..b0cfe16 100644 --- a/docs/more/development/index.rst +++ b/docs/more/development/index.rst @@ -21,6 +21,6 @@ This section provides information on how to develop custom content for |project_ integration-questions/index Project Importers submission-service + Integration via API contributing vulnerabilities - API