From 3121259af405bc2eb95ab934042304f3893b1b53 Mon Sep 17 00:00:00 2001 From: rubysattar Date: Wed, 21 Sep 2022 15:06:11 -0400 Subject: [PATCH 1/6] copied module into forked branch --- modules/6d-labs-postman-standard.md | 128 ++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 modules/6d-labs-postman-standard.md diff --git a/modules/6d-labs-postman-standard.md b/modules/6d-labs-postman-standard.md new file mode 100644 index 0000000..3573f78 --- /dev/null +++ b/modules/6d-labs-postman-standard.md @@ -0,0 +1,128 @@ +# Module 6D: Getting Started with Postman + +![banner](https://user-images.githubusercontent.com/60015240/191588591-935e18ca-bf11-4cf0-a45a-39facb6b77a6.png) + +# What is Postman + +> "Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster." + +Find more information about Postman [here](https://www.postman.com/product/what-is-postman/). + +The Twitter API is accessible via Postman, which makes it simpler to get started with testing and exploring the API. + +Let us look at setting up Authorization and explore some use cases below, to learn how Postman can be leveraged as a tool to enable use of the Twitter API. + +# Setting up +## Fork the Twitter API V2 public collection +The Postman team recommends accessing the Twitter API through Postman's desktop app. In order to follow along, please fork the Twitter API V2 [collection](https://www.postman.com/twitter/workspace/twitter-s-public-workspace/collection/9956214-784efcda-ed4c-4491-a4c0-a26470a67400?action=share&creator=21506762) into your own workspace. + +To accomplish a successful fork in Postman, select the horizontal ellipses (or [Meatballs](https://uxplanet.org/choose-correct-menu-icon-for-your-navigation-7ffc22df80ac)) menu on the collection, select **Create a Fork**, and provide details about the destination workspace. + +![forkTwitterColl](https://user-images.githubusercontent.com/60015240/187228316-b96f5316-3dad-4b9d-9c34-d219a5959396.gif) + +## Create a new Environment to hold keys and secrets +In the workspace where you've added a fork of the Twitter API V2, create a new **Environment** to hold keys and secrets necessary for Authorized use of the Twitter API. The Environment will contain properties that are mentioned within the collection level documentation. Note the addition of Client ID and Client Secret properties. Values must be populated by what's provided to you through the Twitter Developer [Portal](https://developer.twitter.com) when you create a Project and App. + +![envSetupDocs](https://user-images.githubusercontent.com/60015240/191588476-8aafa23b-edaf-46cc-a573-dbb208b28408.png) + +![addEnv](https://user-images.githubusercontent.com/60015240/187230059-aa08600a-491b-42b3-94d5-3a9c71c97b71.gif) + +## Set up Authorization + +You have the option to set up Auth at the **Request** or **Collection** level in Postman, based on your needs. + +### Bearer Token + +For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will be provided to developers who have set up a project and app in Twitter's [developer portal](developer.twitter.com). In this case, you can set Authorization to Bearer Token and insert the token provided by twitter. + + + +### OAuth 2.0 + +Postman has an Auth helper. We can set this up at the Collection level by selecting the **Authorization** tab within our Collection. +- For "type", select **OAuth 2.0** +- For "grant type", select **Authorization Code (with PKCE)** +- For "code challenge method", select **Plain** + - "Scope" will depend on your use case, but **tweet.read** and **users.read** are examples that can be used. + - For "state", you can insert **"State"** + +![auth-helper](https://user-images.githubusercontent.com/60015240/187233234-1789bc48-a87f-4561-bc19-7a22cc56e285.gif) + +Some details you include in the Postman Auth helper must match details in your App settings found in the Twitter Developer Portal. + +For example, see the Callback URL in the app settings found in Twitter: + +![callbackURLtwitter](https://user-images.githubusercontent.com/60015240/191588794-92a684dc-0acc-49a2-b77d-2c6adc002c6d.png) + +See the Callback URL found in Postman's Auth helper: + +![callbackURLpostman](https://user-images.githubusercontent.com/60015240/191588881-e01a46ff-181f-462d-a8ba-1b900f118909.png) + +The Auth URL and Access Token URL will come from Twitter's Developer [Docs](https://developer.twitter.com/en/docs/tutorials/postman-getting-started). + +![authurl](https://user-images.githubusercontent.com/60015240/191589030-b89739b3-b676-414d-a3a3-fe01fc58b82f.png) + + +The Client ID and Client Secret in Postman's Auth helper will point to the Environment variables you previously set. + +![clientidandsecretvars](https://user-images.githubusercontent.com/60015240/191589223-521efa8b-6acd-4669-8b2d-85d3b2d7993d.png) + +# Use Cases +Select the `Run in Postman` button for each of the use cases below to see their documentation within Postman. +>1. "I want to get Tweets about something that happened this past week." + +` insert Run in Postman button when workspace is made Public ` + +>2. "I want to build the entire conversation thread for a Tweet including replies." + +` insert Run in Postman button when workspace is made Public ` + +>3. "I want to get Tweets from a user’s timeline." + +` insert Run in Postman button when workspace is made Public ` + +>4. "I want to write a response from a recent search to a text file." + +` insert Run in Postman button when workspace is made Public ` + +>5. "I want to get a user's tweet timeline." + +` insert Run in Postman button when workspace is made Public ` + +>6. "I want to get a user's mentions." + +` insert Run in Postman button when workspace is made Public ` + +>7. "I want to collect tweets in real time." + +` insert Run in Postman button when workspace is made Public ` + +>8. "I want to collect Tweets in real-time on a breaking event." + +` insert Run in Postman button when workspace is made Public ` + +>9. "I want to get the followers for a user." + +` insert Run in Postman button when workspace is made Public ` + +>10. "I want to get the users that a UserID is following." + +` insert Run in Postman button when workspace is made Public ` + +>11. "I want to lookup users using User IDs." + +` insert Run in Postman button when workspace is made Public ` + +>12. "A fellow researcher shared a set of Tweet IDs and I want build the Twitter dataset for these Tweet IDs." + +` insert Run in Postman button when workspace is made Public ` + +>13. "I want to keep my dataset compliant." + +` insert Run in Postman button when workspace is made Public ` + +# Learn more and get certified through Postman Student Programs + +If you're a student or educator learning or teaching APIs, the Postman student program provides training, resources, and opportunities to support and amplify your projects. + +Find out more about Postman Student Programs [here](https://www.postman.com/student-program/) and fork our Student Expert training collection [here](https://www.postman.com/postman/workspace/postman-student-program). \ No newline at end of file From 516487964d20f112cdf0308737e52a45ed7ab0a1 Mon Sep 17 00:00:00 2001 From: rubysattar Date: Wed, 21 Sep 2022 15:58:56 -0400 Subject: [PATCH 2/6] postman buttons added --- modules/6d-labs-postman-standard.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/modules/6d-labs-postman-standard.md b/modules/6d-labs-postman-standard.md index 3573f78..d4a37ee 100644 --- a/modules/6d-labs-postman-standard.md +++ b/modules/6d-labs-postman-standard.md @@ -71,55 +71,55 @@ The Client ID and Client Secret in Postman's Auth helper will point to the Envir Select the `Run in Postman` button for each of the use cases below to see their documentation within Postman. >1. "I want to get Tweets about something that happened this past week." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-001fc873-6cab-47c0-8752-39d13c4e44e6?action=collection%2Ffork&collection-url=entityId%3D21506762-001fc873-6cab-47c0-8752-39d13c4e44e6%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >2. "I want to build the entire conversation thread for a Tweet including replies." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-85393966-5be2-4f7f-9138-1d1470a8da8b?action=collection%2Ffork&collection-url=entityId%3D21506762-85393966-5be2-4f7f-9138-1d1470a8da8b%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >3. "I want to get Tweets from a user’s timeline." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-ffa24aa6-7115-42ae-aa3e-592b4b1a7f00?action=collection%2Ffork&collection-url=entityId%3D21506762-ffa24aa6-7115-42ae-aa3e-592b4b1a7f00%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >4. "I want to write a response from a recent search to a text file." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-26dcebf8-fd59-4f75-8ff8-944aa4287a5d?action=collection%2Ffork&collection-url=entityId%3D21506762-26dcebf8-fd59-4f75-8ff8-944aa4287a5d%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >5. "I want to get a user's tweet timeline." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-6a998e2f-71fd-4ebe-969c-65860d84c391?action=collection%2Ffork&collection-url=entityId%3D21506762-6a998e2f-71fd-4ebe-969c-65860d84c391%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >6. "I want to get a user's mentions." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-4dd7d934-58e8-4a43-8670-b849b76a5ea1?action=collection%2Ffork&collection-url=entityId%3D21506762-4dd7d934-58e8-4a43-8670-b849b76a5ea1%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >7. "I want to collect tweets in real time." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-50a40abc-539e-4561-b401-d6b348d61859?action=collection%2Ffork&collection-url=entityId%3D21506762-50a40abc-539e-4561-b401-d6b348d61859%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >8. "I want to collect Tweets in real-time on a breaking event." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-b39cff2b-e048-4583-87a0-0e086f82d133?action=collection%2Ffork&collection-url=entityId%3D21506762-b39cff2b-e048-4583-87a0-0e086f82d133%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >9. "I want to get the followers for a user." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-7b277681-5fc3-4c2e-a1e2-41f052710833?action=collection%2Ffork&collection-url=entityId%3D21506762-7b277681-5fc3-4c2e-a1e2-41f052710833%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9)` >10. "I want to get the users that a UserID is following." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-ff9cc83e-3447-491c-8338-ff5d82d2d779?action=collection%2Ffork&collection-url=entityId%3D21506762-ff9cc83e-3447-491c-8338-ff5d82d2d779%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >11. "I want to lookup users using User IDs." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-ebcfeca9-95bc-4028-b832-12cc97d0ded3?action=collection%2Ffork&collection-url=entityId%3D21506762-ebcfeca9-95bc-4028-b832-12cc97d0ded3%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >12. "A fellow researcher shared a set of Tweet IDs and I want build the Twitter dataset for these Tweet IDs." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-50a97d2a-0fa4-4811-8281-ceb9697e8c45?action=collection%2Ffork&collection-url=entityId%3D21506762-50a97d2a-0fa4-4811-8281-ceb9697e8c45%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) >13. "I want to keep my dataset compliant." -` insert Run in Postman button when workspace is made Public ` +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-f6fe4cce-0d5f-4c39-a8eb-3e9fbc008cfa?action=collection%2Ffork&collection-url=entityId%3D21506762-f6fe4cce-0d5f-4c39-a8eb-3e9fbc008cfa%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) # Learn more and get certified through Postman Student Programs From 85b2e320971674ab1323a7e06b5768e2adfc3c2e Mon Sep 17 00:00:00 2001 From: rubysattar Date: Thu, 22 Sep 2022 09:56:36 -0400 Subject: [PATCH 3/6] Removed OAuth mentions,removed buttons, added logo --- modules/6d-labs-postman-standard.md | 78 +++++------------------------ 1 file changed, 12 insertions(+), 66 deletions(-) diff --git a/modules/6d-labs-postman-standard.md b/modules/6d-labs-postman-standard.md index d4a37ee..f804fd4 100644 --- a/modules/6d-labs-postman-standard.md +++ b/modules/6d-labs-postman-standard.md @@ -13,23 +13,19 @@ The Twitter API is accessible via Postman, which makes it simpler to get started Let us look at setting up Authorization and explore some use cases below, to learn how Postman can be leveraged as a tool to enable use of the Twitter API. # Setting up -## Fork the Twitter API V2 public collection -The Postman team recommends accessing the Twitter API through Postman's desktop app. In order to follow along, please fork the Twitter API V2 [collection](https://www.postman.com/twitter/workspace/twitter-s-public-workspace/collection/9956214-784efcda-ed4c-4491-a4c0-a26470a67400?action=share&creator=21506762) into your own workspace. +## Fork the Postman Learning Modules collection using the Run in Postman button +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=collection%2Ffork&collection-url=entityId%3D21506762-d6778526-c8a7-4a88-8f01-da54d4926c05%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) + +## Fork the Twitter API V2 public collection for reference +In order to follow along, please fork the Twitter API V2 [collection](https://www.postman.com/twitter/workspace/twitter-s-public-workspace/collection/9956214-784efcda-ed4c-4491-a4c0-a26470a67400?action=share&creator=21506762) into your own workspace. To accomplish a successful fork in Postman, select the horizontal ellipses (or [Meatballs](https://uxplanet.org/choose-correct-menu-icon-for-your-navigation-7ffc22df80ac)) menu on the collection, select **Create a Fork**, and provide details about the destination workspace. ![forkTwitterColl](https://user-images.githubusercontent.com/60015240/187228316-b96f5316-3dad-4b9d-9c34-d219a5959396.gif) -## Create a new Environment to hold keys and secrets -In the workspace where you've added a fork of the Twitter API V2, create a new **Environment** to hold keys and secrets necessary for Authorized use of the Twitter API. The Environment will contain properties that are mentioned within the collection level documentation. Note the addition of Client ID and Client Secret properties. Values must be populated by what's provided to you through the Twitter Developer [Portal](https://developer.twitter.com) when you create a Project and App. - -![envSetupDocs](https://user-images.githubusercontent.com/60015240/191588476-8aafa23b-edaf-46cc-a573-dbb208b28408.png) - -![addEnv](https://user-images.githubusercontent.com/60015240/187230059-aa08600a-491b-42b3-94d5-3a9c71c97b71.gif) - ## Set up Authorization -You have the option to set up Auth at the **Request** or **Collection** level in Postman, based on your needs. +You have the option to set up Auth at the **Request** or **Collection** level in Postman, based on your needs. In the [Postman collection](https://www.postman.com/the-student-programs-team/workspace/twitter-learning-modules-in-postman/collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=share&creator=21506762) which you can fork, authorization is set to Bearer Token at the collection level. Be sure to assign the `{{bearer_token}}` variable in order to authorize the requests within the collection. ### Bearer Token @@ -37,92 +33,42 @@ For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will -### OAuth 2.0 - -Postman has an Auth helper. We can set this up at the Collection level by selecting the **Authorization** tab within our Collection. -- For "type", select **OAuth 2.0** -- For "grant type", select **Authorization Code (with PKCE)** -- For "code challenge method", select **Plain** - - "Scope" will depend on your use case, but **tweet.read** and **users.read** are examples that can be used. - - For "state", you can insert **"State"** - -![auth-helper](https://user-images.githubusercontent.com/60015240/187233234-1789bc48-a87f-4561-bc19-7a22cc56e285.gif) - -Some details you include in the Postman Auth helper must match details in your App settings found in the Twitter Developer Portal. - -For example, see the Callback URL in the app settings found in Twitter: - -![callbackURLtwitter](https://user-images.githubusercontent.com/60015240/191588794-92a684dc-0acc-49a2-b77d-2c6adc002c6d.png) - -See the Callback URL found in Postman's Auth helper: - -![callbackURLpostman](https://user-images.githubusercontent.com/60015240/191588881-e01a46ff-181f-462d-a8ba-1b900f118909.png) - -The Auth URL and Access Token URL will come from Twitter's Developer [Docs](https://developer.twitter.com/en/docs/tutorials/postman-getting-started). - -![authurl](https://user-images.githubusercontent.com/60015240/191589030-b89739b3-b676-414d-a3a3-fe01fc58b82f.png) - - -The Client ID and Client Secret in Postman's Auth helper will point to the Environment variables you previously set. +# Use Cases +Select the `Run in Postman` button to run a collection which contains all of the use cases below in order to see their documentation within Postman and practice making API calls to the Twitter API. -![clientidandsecretvars](https://user-images.githubusercontent.com/60015240/191589223-521efa8b-6acd-4669-8b2d-85d3b2d7993d.png) +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=collection%2Ffork&collection-url=entityId%3D21506762-d6778526-c8a7-4a88-8f01-da54d4926c05%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) -# Use Cases -Select the `Run in Postman` button for each of the use cases below to see their documentation within Postman. >1. "I want to get Tweets about something that happened this past week." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-001fc873-6cab-47c0-8752-39d13c4e44e6?action=collection%2Ffork&collection-url=entityId%3D21506762-001fc873-6cab-47c0-8752-39d13c4e44e6%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >2. "I want to build the entire conversation thread for a Tweet including replies." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-85393966-5be2-4f7f-9138-1d1470a8da8b?action=collection%2Ffork&collection-url=entityId%3D21506762-85393966-5be2-4f7f-9138-1d1470a8da8b%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >3. "I want to get Tweets from a user’s timeline." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-ffa24aa6-7115-42ae-aa3e-592b4b1a7f00?action=collection%2Ffork&collection-url=entityId%3D21506762-ffa24aa6-7115-42ae-aa3e-592b4b1a7f00%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >4. "I want to write a response from a recent search to a text file." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-26dcebf8-fd59-4f75-8ff8-944aa4287a5d?action=collection%2Ffork&collection-url=entityId%3D21506762-26dcebf8-fd59-4f75-8ff8-944aa4287a5d%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >5. "I want to get a user's tweet timeline." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-6a998e2f-71fd-4ebe-969c-65860d84c391?action=collection%2Ffork&collection-url=entityId%3D21506762-6a998e2f-71fd-4ebe-969c-65860d84c391%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >6. "I want to get a user's mentions." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-4dd7d934-58e8-4a43-8670-b849b76a5ea1?action=collection%2Ffork&collection-url=entityId%3D21506762-4dd7d934-58e8-4a43-8670-b849b76a5ea1%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >7. "I want to collect tweets in real time." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-50a40abc-539e-4561-b401-d6b348d61859?action=collection%2Ffork&collection-url=entityId%3D21506762-50a40abc-539e-4561-b401-d6b348d61859%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >8. "I want to collect Tweets in real-time on a breaking event." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-b39cff2b-e048-4583-87a0-0e086f82d133?action=collection%2Ffork&collection-url=entityId%3D21506762-b39cff2b-e048-4583-87a0-0e086f82d133%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >9. "I want to get the followers for a user." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-7b277681-5fc3-4c2e-a1e2-41f052710833?action=collection%2Ffork&collection-url=entityId%3D21506762-7b277681-5fc3-4c2e-a1e2-41f052710833%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9)` - >10. "I want to get the users that a UserID is following." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-ff9cc83e-3447-491c-8338-ff5d82d2d779?action=collection%2Ffork&collection-url=entityId%3D21506762-ff9cc83e-3447-491c-8338-ff5d82d2d779%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >11. "I want to lookup users using User IDs." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-ebcfeca9-95bc-4028-b832-12cc97d0ded3?action=collection%2Ffork&collection-url=entityId%3D21506762-ebcfeca9-95bc-4028-b832-12cc97d0ded3%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >12. "A fellow researcher shared a set of Tweet IDs and I want build the Twitter dataset for these Tweet IDs." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-50a97d2a-0fa4-4811-8281-ceb9697e8c45?action=collection%2Ffork&collection-url=entityId%3D21506762-50a97d2a-0fa4-4811-8281-ceb9697e8c45%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) - >13. "I want to keep my dataset compliant." -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-f6fe4cce-0d5f-4c39-a8eb-3e9fbc008cfa?action=collection%2Ffork&collection-url=entityId%3D21506762-f6fe4cce-0d5f-4c39-a8eb-3e9fbc008cfa%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) # Learn more and get certified through Postman Student Programs If you're a student or educator learning or teaching APIs, the Postman student program provides training, resources, and opportunities to support and amplify your projects. -Find out more about Postman Student Programs [here](https://www.postman.com/student-program/) and fork our Student Expert training collection [here](https://www.postman.com/postman/workspace/postman-student-program). \ No newline at end of file +Find out more about Postman Student Programs [here](https://www.postman.com/student-program/) and fork our Student Expert training collection [here](https://www.postman.com/postman/workspace/postman-student-program). + +Student (2) \ No newline at end of file From c27390b79c539aa1156477e41442f2179556abd7 Mon Sep 17 00:00:00 2001 From: rubysattar Date: Thu, 22 Sep 2022 11:35:53 -0400 Subject: [PATCH 4/6] images, links, and language updates. --- modules/6d-labs-postman-standard.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/modules/6d-labs-postman-standard.md b/modules/6d-labs-postman-standard.md index f804fd4..171c6a0 100644 --- a/modules/6d-labs-postman-standard.md +++ b/modules/6d-labs-postman-standard.md @@ -1,6 +1,6 @@ # Module 6D: Getting Started with Postman -![banner](https://user-images.githubusercontent.com/60015240/191588591-935e18ca-bf11-4cf0-a45a-39facb6b77a6.png) + # What is Postman @@ -21,17 +21,21 @@ In order to follow along, please fork the Twitter API V2 [collection](https://ww To accomplish a successful fork in Postman, select the horizontal ellipses (or [Meatballs](https://uxplanet.org/choose-correct-menu-icon-for-your-navigation-7ffc22df80ac)) menu on the collection, select **Create a Fork**, and provide details about the destination workspace. -![forkTwitterColl](https://user-images.githubusercontent.com/60015240/187228316-b96f5316-3dad-4b9d-9c34-d219a5959396.gif) +For more information on Forking in Postman, see our [learning center documentation](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities). + +
## Set up Authorization -You have the option to set up Auth at the **Request** or **Collection** level in Postman, based on your needs. In the [Postman collection](https://www.postman.com/the-student-programs-team/workspace/twitter-learning-modules-in-postman/collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=share&creator=21506762) which you can fork, authorization is set to Bearer Token at the collection level. Be sure to assign the `{{bearer_token}}` variable in order to authorize the requests within the collection. +You have the option to set up Auth at the **Request** or **Collection** level in Postman, based on your needs. In the [Postman collection](https://www.postman.com/the-student-programs-team/workspace/twitter-learning-modules-in-postman/collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=share&creator=21506762) which you can fork, authorization is set to Bearer Token at the collection level. Be sure to assign the `{{bearer_token}}` variable in order to authorize the requests within the collection. ### Bearer Token -For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will be provided to developers who have set up a project and app in Twitter's [developer portal](developer.twitter.com). In this case, you can set Authorization to Bearer Token and insert the token provided by twitter. +For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will be provided to developers who have set up a project and app in Twitter's [developer portal](developer.twitter.com). In this case, you can set Authorization at the collection level to Bearer Token and insert the token provided by twitter by hard-coding it where you see `{{bearer_token}}` or by assigning the `bearer_token` variable in the Variables tab at the same collection level. + +
- +
# Use Cases Select the `Run in Postman` button to run a collection which contains all of the use cases below in order to see their documentation within Postman and practice making API calls to the Twitter API. @@ -69,6 +73,6 @@ Select the `Run in Postman` button to run a collection which contains all of the If you're a student or educator learning or teaching APIs, the Postman student program provides training, resources, and opportunities to support and amplify your projects. -Find out more about Postman Student Programs [here](https://www.postman.com/student-program/) and fork our Student Expert training collection [here](https://www.postman.com/postman/workspace/postman-student-program). +Find out more about Postman Student Programs [here](https://www.postman.com/student-program/) and check out our Student Expert training [here](https://www.postman.com/student-program/#student-expert-program). -Student (2) \ No newline at end of file +
Student (2)
\ No newline at end of file From 95b5086e9d1e31b88bb82f5322fb3fcacd8efa1b Mon Sep 17 00:00:00 2001 From: rubysattar Date: Thu, 22 Sep 2022 11:47:39 -0400 Subject: [PATCH 5/6] wrapping images in p tag to style --- modules/6d-labs-postman-standard.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/6d-labs-postman-standard.md b/modules/6d-labs-postman-standard.md index 171c6a0..8caaa8d 100644 --- a/modules/6d-labs-postman-standard.md +++ b/modules/6d-labs-postman-standard.md @@ -23,7 +23,7 @@ To accomplish a successful fork in Postman, select the horizontal ellipses (or [ For more information on Forking in Postman, see our [learning center documentation](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities). -
+

## Set up Authorization @@ -33,9 +33,9 @@ You have the option to set up Auth at the **Request** or **Collection** level in For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will be provided to developers who have set up a project and app in Twitter's [developer portal](developer.twitter.com). In this case, you can set Authorization at the collection level to Bearer Token and insert the token provided by twitter by hard-coding it where you see `{{bearer_token}}` or by assigning the `bearer_token` variable in the Variables tab at the same collection level. -
+

-
+

# Use Cases Select the `Run in Postman` button to run a collection which contains all of the use cases below in order to see their documentation within Postman and practice making API calls to the Twitter API. @@ -75,4 +75,4 @@ If you're a student or educator learning or teaching APIs, the Postman student p Find out more about Postman Student Programs [here](https://www.postman.com/student-program/) and check out our Student Expert training [here](https://www.postman.com/student-program/#student-expert-program). -
Student (2)
\ No newline at end of file +

Student hero image

\ No newline at end of file From 7288c51863d3bb0a770d06ee62bd7428e67b0148 Mon Sep 17 00:00:00 2001 From: rubysattar Date: Wed, 28 Sep 2022 14:49:47 -0400 Subject: [PATCH 6/6] clarity around forking, token, and application --- modules/6d-labs-postman-standard.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/modules/6d-labs-postman-standard.md b/modules/6d-labs-postman-standard.md index 8caaa8d..bf1e2c2 100644 --- a/modules/6d-labs-postman-standard.md +++ b/modules/6d-labs-postman-standard.md @@ -14,24 +14,25 @@ Let us look at setting up Authorization and explore some use cases below, to lea # Setting up ## Fork the Postman Learning Modules collection using the Run in Postman button -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=collection%2Ffork&collection-url=entityId%3D21506762-d6778526-c8a7-4a88-8f01-da54d4926c05%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) +In order to follow the learning module, please fork the `Twitter Academic Research API course - Postman modules` collection by selecting the **Run in Postman** button below. -## Fork the Twitter API V2 public collection for reference -In order to follow along, please fork the Twitter API V2 [collection](https://www.postman.com/twitter/workspace/twitter-s-public-workspace/collection/9956214-784efcda-ed4c-4491-a4c0-a26470a67400?action=share&creator=21506762) into your own workspace. +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=collection%2Ffork&collection-url=entityId%3D21506762-d6778526-c8a7-4a88-8f01-da54d4926c05%26entityType%3Dcollection%26workspaceId%3D3f93788b-6ab4-48ea-ae1f-7ee642de36b9) -To accomplish a successful fork in Postman, select the horizontal ellipses (or [Meatballs](https://uxplanet.org/choose-correct-menu-icon-for-your-navigation-7ffc22df80ac)) menu on the collection, select **Create a Fork**, and provide details about the destination workspace. +If you prefer to fork directly from the Postman app, you can accomplish a successful fork by selecting the horizontal ellipses (or [Meatballs](https://uxplanet.org/choose-correct-menu-icon-for-your-navigation-7ffc22df80ac)) menu on the collection, select **Create a Fork**, and provide details about the destination workspace. For more information on Forking in Postman, see our [learning center documentation](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities). +If you would like to fork the Twitter API V2 collection for reference, you can do so at this [link](https://www.postman.com/twitter/workspace/twitter-s-public-workspace/collection/9956214-784efcda-ed4c-4491-a4c0-a26470a67400?action=share&creator=21506762). +

## Set up Authorization -You have the option to set up Auth at the **Request** or **Collection** level in Postman, based on your needs. In the [Postman collection](https://www.postman.com/the-student-programs-team/workspace/twitter-learning-modules-in-postman/collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=share&creator=21506762) which you can fork, authorization is set to Bearer Token at the collection level. Be sure to assign the `{{bearer_token}}` variable in order to authorize the requests within the collection. +For these learning modules, you will set up authorization at the **Collection** level in Postman. In the [Postman collection](https://www.postman.com/the-student-programs-team/workspace/twitter-learning-modules-in-postman/collection/21506762-d6778526-c8a7-4a88-8f01-da54d4926c05?action=share&creator=21506762) which you have forked (either through the Run in Postman button or manually), authorization is set to Bearer Token at the collection level. Be sure to assign the `{{bearer_token}}` variable in order to authorize the requests within the collection. ### Bearer Token -For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will be provided to developers who have set up a project and app in Twitter's [developer portal](developer.twitter.com). In this case, you can set Authorization at the collection level to Bearer Token and insert the token provided by twitter by hard-coding it where you see `{{bearer_token}}` or by assigning the `bearer_token` variable in the Variables tab at the same collection level. +For some Twitter API V2 endpoints, a Bearer Token is all that's needed and will be provided to developers who have set up a project and app in Twitter's [developer portal](developer.twitter.com). In this case, you can insert the token provided by twitter by hard-coding it where you see `{{bearer_token}}` or by assigning the `bearer_token` variable in the **Variables** tab at the same collection level.

@@ -69,7 +70,7 @@ Select the `Run in Postman` button to run a collection which contains all of the >13. "I want to keep my dataset compliant." -# Learn more and get certified through Postman Student Programs +# Get API certified through Postman Student Programs If you're a student or educator learning or teaching APIs, the Postman student program provides training, resources, and opportunities to support and amplify your projects.