Module
Module 1 of 6Lesson 1 of 1~3 min

Course overview

Lesson 1 of the module "Overview" 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 overview, you will know what you will be able to do (test an API yourself and specify its integration), the two deliverables you will produce on your own product and which five modules get you there.

Where it fits

Overview

What will I be able to design and test by the end of this course, and in what order?

Lessons in this module

  1. Course overview (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