Upgrade Considerations

What has happened in the SDK refresh?

Typically when changing the SDK and models, Momentus Enterprise does not introduce breaking changes for upgrades. While this makes for easy transitions between Momentus versions, this introduces limits for features Momentus can create. 

With the new JWT authentication and SDK refresh, Momentus has taken many advancements (mostly from great suggestions from all of you!) and made a new system with better security, performance and ease of use. This does require you to create API Users and retool your SDK implementations, but Momentus believes the benefits of the new system makes the extra effort worthwhile.

Do I need to upgrade to the new SDK right now?

No, the two authentications do co-exist for now, so no immediate action is required. However, any if you are using the API for the first time, Momentus recommends using the new SDK and JWT systems for future standards and the new benefits and features.

How do I get the latest API functionality?

First, stay current with your Momentus Enterprise version. As you upgrade Momentus, new API functionality is included with it. How you get new features depends on if you use the SDK or not.

With the SDK (Ungerboeck.Api.Sdk) or Model (Ungerboeck.Api.Models) 

You can upgrade to the SDK package that corresponds to the matching Momentus Enterprise version. This ensures your objects and wrapper endpoints reflect the latest features. To match the SDK to your Momentus version, use the second value in the package version. Note that the package still uses Momentus' previous name of Ungerboeck.  See below for an example.

Without the SDK

Review the What’s New document or view the API Help in Momentus v30. To view the API Help, click the API Help link on the Main Menu in Momentus. In the API Help, you can view all the available endpoints along with the ability to see the models for each endpoint.

Update to the New SDK

Momentus has made the SDK upgrades easier starting in .97. You no longer need to uninstall and load a new package but simply upgrade your existing Ungerboeck.Api.Sdk package. Once you upgrade, you have access to any new endpoints, models and properties.

See below for an example using Visual Studio as your NuGet manager:

Upgrading now consists of changing the Ungerboeck.Api.Sdk package version. The second package value refers to the Momentus version. Momentus recommends getting the latest version matching your Momentus version.

Is the API Sandbox up to date with my version?

The API Sandbox and the information it shows always matches the Momentus version you are currently using. Once you upgrade, it shows API information for your new Momentus version. After upgrading your test environment, you can use the API Sandbox to learn about new endpoints.