API V3 & new UI Image updates

Scheduled Maintenance Report for 3Q GmbH

Completed

The changes to the image structure have been completed.

Posted Mar 24, 2025 - 09:19 UTC

In progress

Scheduled maintenance is currently in progress. We will provide updates as necessary.

Posted Feb 20, 2025 - 00:00 UTC

Scheduled

We are planning to update the way images are used in our API V3 and the new UI (platform.3qsdn.com). This will lead to changes in the way images are returned through API requests. Where we currently only return a URI, we will include additional information in the response going forward. This will affect everywhere images are used/returned.

Here's how the changes will look like on the example of the user cover:

Old Response:
{
"id": 1234,
"firstname": "Test",
"lastname": "User",
...
"locale": "en-US",
"cover": "https://sdn-global-prog-cache.3qsdn.com/uploads/COMPANYID/users/02ff862f-1234-5678-945c-6f4b3d40b6bb.png",
...
}

New Response:

{
"id": 1234,
"firstname": "Test",
"lastname": "User",
...
"locale": "en-US",
"cover": {
"id": 1234,
"uri": "https://sdn-global-prog-cache.3qsdn.com/uploads/COMPANYID/users/02ff862f-1234-5678-945c-6f4b3d40b6bb.png",
"altText": "Some Text",
"width": 1920
"height": 1080
"showsTitle": True|False
"copyright": "Some Copyright"
}
...
}

The new UI and API V3 will only return images once a project has been fully processed. We will prioritize the processing of projects that are already being used in the new UI and API V3.
Please pass this information on to your developers if you are already using the API V3 in production. Please note, that further changes like these might follow, as long as the API V3 stays in Beta Status.

There will NOT be any changes in the way images are handled in the API V2 so no changes are necessary there and there will be no effects in the current UI (sdn.3qsdn.com)

Posted Feb 12, 2025 - 18:12 UTC

This scheduled maintenance affected: Platform and REST API.