BConnect POS - Reference PHP

SystemTokenController extends AbstractController
in package

Issues a "system" JWT for server-to-server integrations (for example b-connect-business), authenticated with a shared API key.

Table of Contents

Properties

$systemApiKey  : string
API key expected in the X-API-KEY header, injected from the parameters.

Methods

__construct()  : mixed
generateSystemToken()  : JsonResponse
Generates a system JWT after validating the API key.

Properties

$systemApiKey

API key expected in the X-API-KEY header, injected from the parameters.

private string $systemApiKey

Methods

__construct()

public __construct(ParameterBagInterface $params) : mixed
Parameters
$params : ParameterBagInterface

Provides the system API key (app.system_api_key).

generateSystemToken()

Generates a system JWT after validating the API key.

public generateSystemToken(Request $request, JWTTokenManagerInterface $JWTManager) : JsonResponse
Parameters
$request : Request

Request whose X-API-KEY header is checked.

$JWTManager : JWTTokenManagerInterface

JWT token generator.

Attributes
#[Route]
'/api/system/token'
$name: 'api_system_token'
$methods: ['POST']
Return values
JsonResponse

The generated token; 401 if the API key is missing or invalid.

On this page

Search results