The Legacy Read API was replaced by IM Read API 2.0 in the spring of 2023. Both APIs have been supported in parallel for 2 years to allow companies time to migrate to the new API. The final sunset date for the Legacy Read API is March 1st 2025. Access to the Legacy Read API will cease on this date.

Common Questions:

How do I know if I am using the Legacy Read API?

If your application is calling this endpoint – https://marketplace.api.1worldsync.com – then you are using the Legacy Read API.

How do I know if I am already using the Read API 2.0?

If your application is calling this endpoint – https://content1-api.1worldsync.com – then your are using the Read API 2.0.

I am not technical. How can I determine if I need to migrate to the newer API?

If you are non technical ask your developers to verify the endpoints specified above.

What if I don’t have enough time to complete this conversion?

Contact your 1WorldSycn account representative to see what assistance can be offered.

What steps are involved in converting to the new API?

• Obtain a new key to access the Read API 2.0.
• Modify application to use the new endpoint.
• Modify application to use your new appid + secret
• Modify application to use the new parameters and payload requirements when submitting queries. Note: the new API uses POST not GET.
• Modify application to map attributes from their new locations in the new API instead of their locations in the old API. The schemas for each API are different.

Other than this there should be no other changes necessary. The majority of the developer work would revolve around finding the new locations for attributes.

How do I determine attribute names in the Legacy Read API versus Read API 2.0?

Refer to the Participant Dictionary which is available in 1WorldSync Community platform.

• Find tab “IM Participant Dictionary”
• Column D would be the name in the Read API 2.0.
• Column E would be the name in the Legacy Read API.

How is the Read API 2.0 different than the Legacy Read API?

The Legacy Read API took 2 calls to retrieve an item. The first call would get a page of partial items. Then another call was required to fetch the full item. With the Read API 2.0 only 1 call is required to fetch the entire item data. This makes the new API much faster to page through all of your item data.

The Read API 2.0 also has more total attributes supported than the Legacy Read API did.

The Legacy Read API had a deeply nested data structure reminiscent of the GSDN data model. The Read API 2.0 has a flatter data structure making data retrieval simpler.

Where can I find more information about the Read API 2.0?

Refer to “IM Read API 2.0” in the side bar to the left.