Skip to main content

Generate a session token to transmit it to the extensions frontend fragment

POST/v2/extension-instances/{extensionInstanceId}/sessions/{sessionId}
API version
v2
Request method
POST
Operation ID
extension-generate-session-token

Request​

  • extensionInstanceIdstring (uuid)required
  • sessionIdstring (uuid)required

    ID of the session. Use this to receive session tokens with a stable identifier so that extensions have the possibility to store session information.

Responses​

Format
application/json
Description

The generated session token

  • sessionTokenstringrequired
Content-Type: application/json

{
  "sessionToken": "string"
}
{
  "properties": {
    "sessionToken": {
      "type": "string"
    }
  },
  "required": [
    "sessionToken"
  ],
  "type": "object"
}

Usage examples​

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extension-instances/f0f86186-0a5a-45b2-aa33-502777496347/sessions/f0f86186-0a5a-45b2-aa33-502777496347
import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionGenerateSessionToken({
  "extensionInstanceId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "sessionId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionGenerateSessionToken\ExtensionGenerateSessionTokenRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ExtensionGenerateSessionTokenRequest(
  extensionInstanceId: "f0f86186-0a5a-45b2-aa33-502777496347",
  sessionId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->extensionGenerateSessionToken($request);

var_dump($response->getBody();

On this page