1
- API Keys
2
- ========
1
+ API Key
2
+ =======
3
3
4
4
How to get an API Key
5
5
---------------------
6
6
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:
8
9
9
10
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.
12
13
4. Open the 'API Keys' tab
13
14
5. Use the 'Generate Key' button
14
15
6. Enter a description for this new key
@@ -24,7 +25,7 @@ If doing so, your ``.env`` file should contain a line such as:
24
25
API Client
25
26
----------
26
27
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.
28
29
In your code, you must first initialize and configure a ``simscale_sdk.ApiClient `` object, which
29
30
holds the data for the host, identification header and API Key. This object is later used to
30
31
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
57
58
.. code-block :: csharp
58
59
59
60
// C#
60
-
61
+
61
62
using System ;
62
63
using SimScale .Sdk .Api ;
63
64
using SimScale .Sdk .Client ;
0 commit comments