☰ Menu

Migration Guide - 2023

Welcome to the 2023 Migration Guide. This document outlines the key changes, new features, and steps required to successfully migrate your existing integrations to the latest version of our platform.

Introduction

The 2023 release brings significant enhancements aimed at improving performance, security, and developer experience. We've focused on streamlining workflows and providing more robust tools for your applications. This guide will walk you through the essential updates you need to be aware of.

Please review this document carefully before commencing any migration to ensure a smooth transition.

What's New in 2023

This year's release introduces several exciting features:

  • Enhanced Real-time Data Streaming: Lower latency and higher throughput for real-time data feeds.
  • New Webhook Capabilities: More flexible and powerful event-driven notifications.
  • Advanced Analytics API: Access to deeper insights and custom reporting tools.
  • Improved Security Protocols: Implementation of the latest industry-standard security measures.

Core Changes

Several fundamental aspects of our platform have been updated. Understanding these changes is crucial for successful migration.

API Endpoints

We have introduced new API endpoints and modified existing ones to better serve your needs. Please refer to the v3 API Documentation for a comprehensive list.

Important: Many endpoints from previous versions have been deprecated. Ensure you are using the new endpoints to avoid service disruptions.

Example of a new endpoint structure:

GET /api/v3/resource/{id}

Data Structures

Significant updates have been made to the data structures returned by the API. Key changes include:

  • Renamed fields for clarity and consistency.
  • Introduction of new fields for enhanced data representation.
  • Updated data types for certain properties to improve precision.

For detailed schema information, please consult the API Schemas.

Authentication

The authentication mechanism has been upgraded to OAuth 2.0 with improved token management. The legacy API key system will be fully retired by the end of Q2 2024.

Migration Steps:

  • Generate new OAuth 2.0 credentials via your developer dashboard.
  • Update your client applications to use the new OAuth flow for obtaining access tokens.
  • Implement refresh token logic to maintain uninterrupted access.

Refer to the OAuth 2.0 Guide for detailed instructions.

Performance Improvements

We have invested heavily in optimizing the platform's performance. You can expect:

  • Up to 30% faster response times for common API calls.
  • Reduced resource consumption for background processes.
  • Enhanced scalability to handle larger loads.

These improvements are largely automatic, but ensuring your client applications are making efficient requests will maximize the benefits.

Deprecations

As part of our continuous improvement, certain older features and endpoints are being retired.

Old Features

The following features are scheduled for deprecation:

  • Legacy API endpoints (e.g., /api/v1/, /api/v2/).
  • Certain older data export formats.
Warning: Continued reliance on deprecated features may lead to unexpected behavior or discontinuation of service without prior notice.

Migration Steps

To migrate away from deprecated features:

  • Consult the Core Changes section for updated API endpoints and data structures.
  • Review the v3 API Changelog for specific endpoint deprecation timelines.
  • Update your code to use the recommended alternatives.

Troubleshooting

Encountering issues during migration? Here are some common problems and their solutions:

  • Authentication Errors: Double-check your OAuth 2.0 credentials and token expiration. Ensure you are using the correct grant type.
  • Data Format Mismatches: Verify that your application is parsing the updated data structures correctly. Refer to the API Schemas.
  • Endpoint Not Found (404): Ensure you are calling the correct, updated API endpoints.

For more detailed troubleshooting, visit our Support Forum.

Frequently Asked Questions (FAQ)

Q: When will the legacy API endpoints be completely shut down?
A: All legacy API endpoints are planned to be fully retired by the end of Q2 2024. We encourage migration well before this date.

Q: Is there a rollback strategy if migration fails?
A: We recommend thorough testing in a staging environment. For critical issues, reverting to your previous integration version is possible, but it's best to resolve migration blockers.

Q: Where can I find version-specific SDKs?
A: Updated SDKs for various languages can be found in our SDK Repository.