Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To use the PQ Portal API, privileged user account is required. If you don’t have access to the PQ Portal yet, get in contact with your connecting TSO.

Register an API Client via the PQ Portal

Use a PQ Portal privileged user account to register a new OAuth client. The option for the client generation is located in the upper right corner of the page under <your_username> → API Clients. When generating a new client make sure to save the individual authentication data as it is displayed just once.

Info

For the Trainings Portal you should go on PRÄQUALIFIKATIONS-PORTAL > Start (pq-portal.energy). You or your company should have received an invitation mail for your company. You register as usual and fill out your personal data. Now you switch to the “Erbringungskonzepte” tab. The layout should change and you find a round icon on the right upper corner with your initials. Click on that and choose “API Clients”.

Here you can add a new API client. Please save the credentials as you will not be able to see them again.

The individual authentication data contains:

  • Client ID: The name of the client which is allowed to access the PQ Portal API. Use later as username.

  • Client Secret: Password used to login to the PQ Portal API.

Authenticate client and get authorization to access data

Code Block
curl -u <your_clientid>:<your_clientsecret>
-X POST https://training.pq-portal.energy/oauth/token?grant_type=client_credentials 

Response:

Code Block
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiY...",
    "token_type": "bearer",
    "expires_in": 3999,
    "scope": "read write",
    "providerId": "xxx",
    "jti": "8f3a2f56-2893-496b-90ae-90eed152e20b"
}

...

Access Resources

Please follow the instructions on General API Information.

...

Next steps