Migrating CYPHER Learning API v2 to API v3

Migrating CYPHER Learning API v2 to API v3

Introduction

This document outlines a critical update regarding our internal API. To ensure we maintain a consistent, secure, and efficient infrastructure across all our systems, we will be deprecating API v2 in favor of our enhanced API v3. This change will affect all internal applications and services that currently rely on API v2.

What's Changing?

While both API v2 and v3 follow RESTful principles, API v3 introduces several key improvements and changes designed to enhance our internal systems:
  • Improved Performance:
    • API v3 has been optimized for speed and efficiency, resulting in faster response times and reduced latency.
    • This will improve the performance of all internal applications and services.
  • Expanded Functionality:
    • API v3 offers [Specify new features, e.g., new endpoints, expanded data fields, improved error handling, webhooks, etc.].
    • These additions provide more comprehensive access to our internal data and enable more advanced internal workflows.
  • Standardized Data Formats:
    • API v3 utilizes [Specify data format changes, e.g., consistent JSON structures, improved data validation, etc.].
    • This will create a more predictable experience and lessen development time.

Key Changes to Note

  • Endpoint Changes
    • Some endpoint URLs may have been modified or consolidated. Please refer to the updated API v3 documentation for the complete list of endpoints.
  • Data Structure Modifications
    • Certain data fields and structures have been updated. Please review the API v3 documentation for the new data models.

What You Need to Do (By Department/Team)

  • Administration Team:
    • Review the API v3 documentation in the knowledge base. 
    • Install API 3.0 in the CYPHER App Center.
    • In the Admin Console, navigate to the API tab.
    • Generate a new API key by clicking “+ Add” in the top right corner.
    • Select version 3.0 and name the API Key something indicative of where it will be used.
    • Click the enabled checkbox for the new API key on the far right of the screen.
    • Click the name of the new API key.
    • Set restrictions to match your current production API key configuration.
    • Securely share the Secret Key with the team members who will be updating the API calls.
  • Development Teams:
    • Review the API v3 documentation in the knowledge base. 
    • Identify all internal applications and services that use API v2.
    • Update those applications and services to use API v3, including endpoint changes, data structure modifications, and authentication updates.
    • Conduct thorough testing in a development/staging environment.
    • Coordinate deployment with the infrastructure team.
  • Infrastructure Teams:
    • Prepare the infrastructure for API v3 deployment.
    • Ensure proper monitoring and logging of API v3 usage.
    • Assist development teams with deployment and troubleshooting.
  • Data Teams:
    • Update any internal data pipelines that utilize the old API.
    • Ensure data integrity during the migration.
  • All Departments:
    • Familiarize yourselves with the new API documentation.
    • Report any issues or concerns to the appropriate support channels.

Benefits of Migrating to API v3

  • Improved Performance: Experience faster response times and reduced latency across all internal systems.
  • Access to New Features: Leverage the expanded functionality of API v3 for improved internal workflows.
  • Increased Reliability: Benefit from a more stable and robust API.
  • Future-Proof Infrastructure: Ensure our systems remain compatible with future updates.

Conclusion

This migration is essential for maintaining the security, performance, and scalability of our internal systems. Your cooperation and timely migration are crucial for a smooth transition.