Postman setup

postman-setup.md

Postman setup instructions

Account sign-up

1. Using founder's email (like [email protected]) or project account email (like [email protected])
2. Add Founder's credit card to the account
3. Rename the "My Workspace" to "Product/Project Personal Workspace"
4. Create a new workspace (Team Workspace, not Personal Workspace) - labelled "API Workspace" (or something appropriate)
5. Create a new team, and add project members with "Developer" level access (without "Billing/Admin" access)
6. Copy over the collections from the platform APIs (ci, dev, and qa collections) and have those setup in the Postman - update the required collection variables

GitHub Integration

1. Home > Integrations > Create new integration > "Backup a collection"
2. Create a new GitHub access token [fine-grained token, using DevOps GitHub account - this would be generated by BE tech-leads]
3. Using the token, finalise the collection-backup setup [screenshot attached]
4. The "ci" collection is the one that should be backed up to the API repo

Collection setup

There are supposed to be 3 collections in Postman : ci, dev and qa

ci

1. The one that runs at CI environments
2. The one that is backed up to GitHub API repo as soon as any change is made
3. The one, when updated, triggers a new build/deployment

dev

1. The one that is continuously updated by the BE devs
2. The one that is used for integration with FE
3. The one that acts as the source of truth of the APIs - hence the one to be referred from documentation POV

qa

1. The one that QA team uses for adding newer test cases/scenarios
2. The one that, and once verified to be working fine, replaces/is-merged-with the "ci" collection