Skip to content

Commit eb230be

Browse files
committed
Adding gif instrutionals for README Getting Started section.
Adding gif instrutionals for README Getting Started section.
1 parent b837649 commit eb230be

6 files changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,34 @@
33
1.- First thing to do is to import all the environments into your Postman application.
44
The environments are a set of rules that tell postman what endpoint it should be contacting, for example production, Edog or Local deployment.
55
To do this, go to the "Manage Environments" menu in the top right settings icon, open it and click on the import button.
6+
7+
![Manage_Environments-Import](/img/Manage_Environments-Import.gif)
8+
69
Select all the files under the Environments folder and load them into Postman. Verify that all the new environments have been loaded by
710
clicking in the drop down to the left of the "Manage Environments" menu.
811

12+
![Manage_Environments-Import](/img/Manage_Environments-DropDown.gif)
13+
914
2.- Now that you have all the environments loaded into your workspace, is time to load a collection of requests. These are the actual HTTP requests
1015
that postman will use to contact the selected environment. To do this, go to "File > Import" and drag all the collections files under the Collections folder.
16+
17+
![Manage_Environments-Import](/img/Collection-Import.gif)
18+
1119
This will load all the HTTP requests that have been preconfigured for use with the OneNote API.
1220

1321
3.- The last thing to do is to specialize your collection to your local environment, this will tell postman what parameters to use for your machine and for your specific request scenarios.
1422
a.- Right click over the Collection that you want to configure and select Edit. This will open the collection configuration, in here navigate to the variables tab.
1523
Look for the "MachineName" parameter and add your machine's name TO THE "CURRENT VALUE" ONLY
1624
*** Do not add any of these local parameters to the initial value, the initial value is exported and we don't want to share these parameters with others ***
25+
26+
![Manage_Environments-Import](/img/Collection-Variables.gif)
27+
1728
b.- Go back into the "Manage Environments" menu and click on the "Globals" button. Here you will see the two different types of AuthTokens used to contact Production or PPE environments.
18-
Add the necessary auth tokens to these variables (CURRENT VALUE ONLY) and hit save. The AuthTokens will expire after a while so you will have to come back and update their values every time
29+
Add the necessary auth tokens to these variables (CURRENT VALUE ONLY) and hit save.
30+
31+
![Manage_Environments-Import](/img/Manage_Environments-Globals.gif)
32+
33+
The AuthTokens will expire after a while so you will have to come back and update their values every time
1934
that happens.
2035

2136
Now you should be able to open any of the requests and hit the Send button to execute.

img/Collection-Import.gif

321 KB
Loading

img/Collection-Variables.gif

242 KB
Loading

img/Manage_Environments-DropDown.gif

132 KB
Loading

img/Manage_Environments-Globals.gif

215 KB
Loading

img/Manage_Environments-Import.gif

188 KB
Loading

0 commit comments

Comments
 (0)