{"version":"https:\/\/jsonfeed.org\/version\/1","title":"Postman Configuration Tutorial > Docman Help","home_page_url":"https:\/\/help.docman.com\/knowledge-base\/postman-configuration-tutorial\/","feed_url":"https:\/\/help.docman.com\/knowledge-base\/postman-configuration-tutorial\/feed\/json","author":{"name":"nextSTL","url":"https:\/\/help.docman.com"},"items":[{"title":"Postman Configuration Tutorial","date_published":"2018-06-21T13:38:54Z","date_modified":"2018-08-16T09:36:52Z","id":"https:\/\/help.docman.com\/knowledge-base\/postman-configuration-tutorial\/","url":"https:\/\/help.docman.com\/knowledge-base\/postman-configuration-tutorial\/","author":{"name":"Oliver Edwards","url":"","avatar":"https:\/\/secure.gravatar.com\/avatar\/916760a3861c94b0f12d9658070815ac6150c9ba5291c9b5304733d70e0fdb9e?s=96&d=mm&r=g"},"summary":"Introduction\r\nThis article describes how to run the Docman API collection in the postman desktop client.\r\n\r\nPostman is an API development tool that makes sending and receiving web requests to a REST API easy! Use postman to test and learn the Docman \u2026","content_html":"

Introduction<\/h1>\r\nThis article describes how to run the Docman API collection in the postman<\/a> desktop client.\r\n\r\nPostman is an API development tool that makes sending and receiving web requests to a REST API easy! Use postman to test and learn the Docman API before implementing any code.\r\n

Run in Postman tutorial<\/h1>\r\nThe tutorial starts on the Docman API online documentation page.\r\n\r\nClick on \"Run in Postman\" button\r\n\r\n\"\"\r\n\r\nA new page will open. \"Click Postman for Windows\" to run postman in the native postman desktop application. Make sure you have already installed the postman application and if not click here<\/a> to download and install.\r\n\r\n\"\"\r\n\r\n \r\n\r\n[ht_message mstyle=\"alert\" title=\"Postman Chrome\" \" show_icon=\"\" id=\"\" class=\"\" style=\"\" ]Postman as a Google Chrome app is now being phased out and not supported by Docman[\/ht_message]\r\n\r\nIn chrome an alert might show up to set a default app for opening postman links. Click on \"Open Postman\".\r\n\r\n\"\"\r\n\r\nThe Docman API collection will be imported into the postman application as new collection named \"Docman API\".\r\n\r\n\"\"\r\n\r\nTo make it easy Docman have set up a sandpit environment to test the Docman API against. This is also configured as a postman\u00a0environment<\/a>, all web requests in the Docman API collection reference variables in the postman environment named \u201cDocman Public Sandpit\u201d.\r\n\r\nNote:\u00a0<\/strong>The variable values are\u00a0blank\u00a0<\/strong>to start with and you need to modify some of them with details provided by Docman such as API username and password.<\/em>\r\n\r\nTo edit the variables, continue to follow this tutorial. Alternatively, edit the variables in each call in the Docman API collection.\r\n\r\nTo edit the variables, continue to follow this tutorial. Alternatively, edit the variables in each call in the Docman API collection.\r\n\r\nClick the cog icon in the top right of the postman application.\r\n\r\n\"\"\r\n\r\nClick \"Docman Public Sandpit\".\r\n\r\n\"\"\r\n\r\n \r\n\r\nModifiy the values using the table as guidance and click \"update\".\r\n\r\n[su_table]\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
Value<\/td>\r\nDescription<\/td>\r\nRequired<\/td>\r\n<\/tr>\r\n
ENV_HOST<\/td>\r\nURL of API, this will be provided to you by Docman<\/td>\r\nYes<\/td>\r\n<\/tr>\r\n
ENV_HOST_PORT<\/td>\r\nEither HTTP or HTTPS<\/td>\r\nYes<\/td>\r\n<\/tr>\r\n
ENV_USERNMAE<\/td>\r\nUnique username supplied to you by Docman.<\/td>\r\nYes<\/td>\r\n<\/tr>\r\n
ENV_PASSWORD<\/td>\r\nUnique password supplied to you by Docman.<\/td>\r\nYes<\/td>\r\n<\/tr>\r\n
ENV_ODSCODE<\/td>\r\nOrganisation OdsCode you are trying to send and receive documents for<\/td>\r\nYes<\/td>\r\n<\/tr>\r\n
ENV_PATIENT_ID<\/td>\r\nNHS Number of patient you are trying to interact with<\/td>\r\nNo<\/td>\r\n<\/tr>\r\n
ENV_DOCUMENT_GUID<\/td>\r\nDocument guids are used in the web request and this value can be modified at runtime.<\/td>\r\nNo<\/td>\r\n<\/tr>\r\n<\/tbody>\r\n<\/table>\r\n[\/su_table]\r\n

Using Docman API in Postman<\/h1>\r\n ","tags":[]}]}