API events for target platform changes

We have extended our APIs to let systems integrated with BeBanjo detect and react to changes in target platforms when an image or rendition is updated. This note describes this change in full, and as usual you can contact support or your Technical Account Manager for further clarification.

The thinking behind this change was: if a user can see the target platform changes in the BeBanjo user interface, there is no reason why an external system shouldn’t get the same information via our APIs. So we have added API events for the creation, update and deletion of target platforms related to images or renditions. The subject link of those events will point to the relevant image or rendition, and that link may be expanded, as normal, via the API.

Here’s an example of what a target_platform_created event looks like, with the subject expanded:

<events>
 <event>
  <id type="integer">143994751</id>
  <event-type>target_platform_created</event-type>
  <timestamp type="datetime">2019-12-17T09:20:45Z</timestamp>
  <link rel="self" href="https://staging-movida.bebanjo.net/api/events/143994751"/>
  <link rel="subject" href="https://staging-movida.bebanjo.net/api/target_platforms/18679924">
    <subject>
      <id type="integer">18679924</id>
      <link rel="self" href="https://staging-movida.bebanjo.net/api/target_platforms/18679924"/>
      <link rel="image" href="https://staging-movida.bebanjo.net/api/images/2402880"/>
    </subject>
  </link>
 </event>
</events>

You can have a look at the updated Event API documentation here.

For more information on target platforms, the technical documentation describing how they work in the API can be found here.

We hope you will find this useful and, if you have any questions, make sure to let your TAM know!

References

• movida#8846 Add API events for target platforms