Skip to main content

Migrating from SDK v1 to v2

This page provides guidance for migrating your existing Entrupy iOS SDK v1 integration to SDK v2.

Functional Equivalence​

For its initial release, iOS SDK v2 is functionally identical to SDK v1. The underlying authentication processes, API interactions (primarily with Entrupy API v1.3), and core SDK method signatures remain largely the same.

The primary changes in v2 are focused on:

  • Improved Documentation: A completely reorganized and rewritten documentation set for better clarity and navigability.
  • Future Enhancements: SDK v2 lays the groundwork for future feature additions and improvements.

Key Recommendations​

  1. Review New Documentation: Familiarize yourself with the new documentation structure:

    • Overview: High-level introduction to the SDK.
    • Integration Guide: Step-by-step instructions for new integrations (also useful for verifying your existing v1 setup against best practices).
    • SDK Reference: Detailed information on specific components, delegates, and APIs.

  2. Verify API Endpoints: While the SDK's interaction patterns are consistent, ensure your backend is interacting with the correct and latest recommended Entrupy API versions for tasks like user authorization and data queries.

  3. No Immediate Code Changes Required (Typically): Due to functional equivalence, you should not need to make immediate, extensive changes to your existing SDK v1 integration code when adopting SDK v2 libraries. However, it is always a good practice to test thoroughly.

  4. Update SDK Dependency: Update your project's dependency (e.g., in your Podfile) to point to the new iOS SDK v2 version.

Accessing Legacy v1 Documentation​

For reference, the complete documentation for the SDK v1 is still available:

This can be useful for comparing specific sections or if you need to refer to the original v1 text during your transition.

Future Migration Notes​

As SDK v2 evolves and introduces new features or potential breaking changes from v1 functionality, this page will be updated with detailed migration steps and considerations.

If you encounter any issues or have questions during your migration, please contact Entrupy support.