Skip to content

Commit 830eafe

Browse files
committed
Improve api keys
1 parent 3437363 commit 830eafe

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

tutorial/api_keys.rst

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
API Keys
2-
========
1+
API Key
2+
=======
33

44
How to get an API Key
55
---------------------
66

7-
Your personal API Key is generated in the SimScale platform. Follow these steps:
7+
A SimScale API Key is tied to a platform account. In order to generate one for your account,
8+
please follow these steps:
89

910
1. Sign in to the SimScale platform in `www.simscale.com <https://www.simscale.com/>`_
10-
2. Open account menu at the top left
11-
3. Go to 'Manage Account' or 'User Preferences', depending on wether you are in the Workbench
11+
2. Open the account menu by hovering over your user name at the top right
12+
3. Go to 'Manage Account' or 'User Preferences' on the menu, depending on wether you are in the SimScale Workbench or the website.
1213
4. Open the 'API Keys' tab
1314
5. Use the 'Generate Key' button
1415
6. Enter a description for this new key
@@ -24,7 +25,7 @@ If doing so, your ``.env`` file should contain a line such as:
2425
API Client
2526
----------
2627

27-
User authentication with the SimScale API is performed using the ``X-API-KEY`` request header.
28+
User authentication in the SimScale API is performed using the ``X-API-KEY`` request header.
2829
In your code, you must first initialize and configure a ``simscale_sdk.ApiClient`` object, which
2930
holds the data for the host, identification header and API Key. This object is later used to
3031
setup the different Api clients specific to each platform action.
@@ -57,7 +58,7 @@ The following snippet shows an example of the creation and setup of the ``ApiCli
5758
.. code-block:: csharp
5859
5960
// C#
60-
61+
6162
using System;
6263
using SimScale.Sdk.Api;
6364
using SimScale.Sdk.Client;

0 commit comments

Comments
 (0)