Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space PDOIDC and version master

Contents

Table of Contents
excludeContents

...

  • Robustness during periods of high traffic load.
  • Improved handling of scenarios with a an unusually long response time. In general, the asynchronous service will deliver a response just as fast as before. But some requests are more an advantage is that the most time-consuming than others, and those requests will more often lead to a successful response in the asynchronous service. Even cases previously disrupted by short term downtime can now be handled successfully with a delayed response.
  • Webhook notifications, making polling unnecessary
  • Batch support (coming later)

...

Note

The Asynchronous Session API is currently in a

Status
colourYellow
titleBeta
stage.

There might still be some bugs or inconsistencies, and changes could happen.

Please contact the team if you want to test out this API at this stage.

When this API is finished and ready, the old synchronous API will be

Status
titledeprecated
.

At that pointan alternative to the older synchronous API.

  • We will encourage all existing integration partners to migrate to the new asynchronous alternative
  • New integration partners must only use the asynchronous API

...

Note

The API documentation suffers from a bug affecting scrolling when presented through the Chrome browser. We recommend using a different browser until this issue is resolved.

...

A range of different webhooks is available to be sent with notifications about events. Which webhooks you want to receive is a choice in the session request.

Webhook statusMeaning
JsonDataReadyThe JSON content is ready for download
ReportReadyA PDF report is ready for download
AllDoneThe session is finished, and all contents are ready for download
FailedSomething went wrong, and the session has been canceled.

...