This guide explains how a Congestion Service Provider (CSP) can connect to the GOPACS Redispatch APIs.
The following sections describe the available API endpoints, the required authentication method, and the configuration steps needed to establish a successful connection.
The steps in the instruction manual are described in table form to clearly define the steps. The following columns are defined.
Column | Definition |
|---|---|
Step | Order in which the steps are needed to be executed. |
Description | Describes in detail what happens in the step. |
Is a term unclear? You’ll likely find its definition in our Glossary.
The English the glossary is located here: Glossary - GOPACS
De Nederlandse begrippenlijst vind je hier: Begrippenlijst - GOPACS
More manuals can be found here: Manuals
If you need help or have questions, you can find our details here: Contact
Step | Description |
|---|---|
1 | Retrieve announcements Create an API integration with the Swagger UI endpoint to retrieve redispatch announcements. It is recommended to poll this endpoint every five minutes using the appropriate filters for your use case. The ‘starttime’ and ‘endtime’ filters use Unix Epoch timestamps in milliseconds. These filters are applied to the announcement's ‘createDate’ field. Note: No authentication is required for this endpoint. Location:
|
2 | Generate an API key To access authenticated redispatch API endpoints, you first need to generate an API key in GOPACS.
Store the generated API key securely, as it will be required in the next step. |
3 | Retrieve asset effectiveness Create an API integration with this Swagger UI endpoint to determine how effectively your assets can help resolve a specific congestion issue. Authenticate your requests using the API key generated in Step 2. Use the announcementId obtained from the announcements endpoint described in Step 1. Location:
Replace |
Step | Link | Description |
|---|---|---|
1 | Swagger for the 'Machine announcements' endpoint. Used to retrieve announcements. | |
2 | Swagger for the ‘Ean Solving Effectivities’ endpoint. Used to determine how effective the Trading Company’s assets are in solving a specific problem. Input is announcementId. |