This document describes the process of upgrading to version 2 of the Mobile Engage API. We have implemented changes in the following areas:

We encourage all our customers to upgrade immediately. Not only is the new functionality only avaialble in v2, but v1 will cease to be supported by the end of 2016.

App Login Endpoint

We have included the functionality of three earlier endpoints: the app_launch, the contact_update and the push_accepted into the new login endpoint.

The login endpoint offers the full functionality of the previous endpoints: it can handle the application launch, the registration process as well as the event where clients agree to receive push notifications.

For those customers who have implemented the earlier versions of our API endpoints, the task is simply to replace the three endpoints in the app with the new login endpoint.

For more information, see the description of the Login Endpoint.

New data flow model

In our new data flow model, the app is always linked to the device and the platform. The difference from the earlier model is the way the users of the app are handled.

When an app is launched without a logged-in user and a push token, the login endpoint is called, but without the personal identifier data. In these cases it has to be determined if there is a contact associated with the device.

  • If yes, its contact_id is associated with the device.
  • If not, a Mobile Engage Created (MEC) contact is linked. Other identification means, such as the email address, are not known.

If there is a login event, the login endpoint is called again, with the personal identifier data, such as an email address. If there is a push token added to the data sent as well, push notifications can be sent to the client.

When the logout endpoint is called due to a logout event, the MEC contact is again associated to the device.

For more information, see the description of our Data Flow Model.