Authentication

To access the Dlubal API, you need just to authenticate yourself. Authentication is handled using an API Key, which is automatically included in all requests for validation.

API Key Management

API keys are unique identifiers used to authenticate the client making a request. While they are linked to your User Account, their usage can extend further. Think of an API key as a project-specific identifier that allows you to share it within your company and track API requests separately for each project.

You can manage your API keys in Extranet > API & Cloud.

Important

When you generate a new API key, make sure to copy and securely store it immediately. For security reasons, the key will not be accessible or shown again after creation.

Authentication Process

The authentication process for API requests follows these steps:

1. Input the API key in the client initialization

   PythonC#

   from dlubal.api import rfem
   
   # Option 1: Specify API key directly as a parameter
   with rfem.Application(api_key_value="ak-e72f5da...") as rfem_app:
   # Do a stuff
   
   # Option 2: Specify API key using a name from the config.ini file
   with rfem.Application(api_key_name="project_2") as rfem_app:
   # Do a stuff
   
   # Option 3: Automatically use the last used API key as default from the config.ini file
   with rfem.Application() as rfem_app:
   # Do a stuff
   

   Important

   Using an api_key_name from dlubal/api/config.ini is the preferred method, as it helps keep api_key_values secure when sharing scripts.

   config.ini example:

   [api_keys]
   project_1 = ak-e72f5da141ba4cce8b736c05ae444f5791aa8b17a372f24c
   project_2 = ak-e72f5da141ba4cce198913bb39924c4ca8d78f75623b014a
   default = ak-e72f5da141ba4cce8b736c05ae444f5791aa8b17a372f24c
   

2. The server validates the API key against your company profile.

3. If the key is valid, the request proceeds; otherwise, an error response is returned:

   RuntimeError: gRPC Connection error:
   UNAUTHENTICATED - API key is invalid or in incorrect format.
   For more information, see https://apidocs.dlubal.com/access_control.html.
   

Access limitations

If there is achieved a limit for API request count per month given by API service subscripton (see Subscriptions & Pricing), an error response is returned:

grpc._channel._InactiveRpcError: <_InactiveRpcError of RPC that terminated with:
   status = StatusCode.UNAUTHENTICATED
   details = "API access has been restricted. Your company does not have permission to use the Dlubal API Service, or the limits defined in your subscription plan have been exceeded."