Module
Module 5 of 6Lesson 3 of 3~13 min

Sandbox, production, versions and deprecations

Lesson 3 of the module "An integration that lasts" in the course "Design and test an API integration as a PM".

Take this lesson: your first course is freeSee the full syllabus

Lesson objective

By the end of this lesson, you will be able to plan in a spec the move from sandbox to production, the choice and pinning of an API version, the distinction between breaking and compatible changes, and the monitoring of deprecations.

Where it fits

An integration that lasts

How does the integration withstand large volumes, limits, outages, duplicates and new versions?

Lessons in this module

  1. Pagination and rate limits
  2. Webhooks and idempotency, with no duplicates and no lost events
  3. Sandbox, production, versions and deprecations (this lesson)

What you will learn in the course

This lesson is part of the course Design and test an API integration as a PM

  • Read a REST API's documentation (resources, endpoints, methods, parameters, JSON bodies, OpenAPI description) and extract what the integration needs.
  • Send, save and test requests in Postman or Bruno (collection, environments, variables, assertions) to check an API's real behavior.
  • Interpret status codes and error responses, and decide the product behavior (fix, retry, alert, inform the user).
  • Choose and specify the authentication method (API key, token, OAuth 2.0), the minimal permissions and the rules for managing secrets.
  • Specify pagination, rate-limit handling, webhooks and idempotency for an integration that withstands volumes, outages and duplicates.
  • Plan environments (sandbox, production), versions, breaking changes and deprecations in the spec and the test plan.
  • Write a complete integration spec, with a collection of tested requests, ready to be estimated by the team.

Related courses