{"__v":0,"_id":"57c9b6f2860b1f0e00879260","category":{"__v":6,"_id":"563a4fcaa19edf0d00972321","pages":["563a50051846790d0089535e","564ba1cf5cc43717009bcfe9","565a60d433140c0d0033930c","5673222e47f7010d005bfd7c","56afd2f5d21e9c0d00b62962","56be2bff6cae110d00190c05"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T18:34:50.832Z","from_sync":false,"order":1,"slug":"guides","title":"Guides"},"parentDoc":null,"project":"55773a5ba042551900b002cb","user":"546d17e2eb9cfd1400dd4529","version":{"__v":17,"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","createdAt":"2015-06-09T19:11:23.764Z","releaseDate":"2015-06-09T19:11:23.764Z","categories":["55773a5ca042551900b002cf","55773a6ce6063e0d00481380","55773ab007e7110d001043ec","55773abaa042551900b002d5","55773ac207e7110d001043ed","55773acb07e7110d001043ee","55773ad3a042551900b002d6","55773adce6063e0d00481383","55773ae4a042551900b002d7","55773af307e7110d001043ef","55773af907e7110d001043f0","55773b0407e7110d001043f1","563a4f7ad25e8919005f3f39","563a4fcaa19edf0d00972321","564a70dc4cd0521700523edf","564b797bcc472d0d00da9435","564b855b766d4923004e1fd1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-09-02T17:29:22.263Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"For many of the APIs there is a **Run in Postman** link that will import a predefined collection into the [Postman API client](https://www.getpostman.com/) providing a simple interface into each APIs methods as well as all parameters that are available. The [Postman app](https://www.getpostman.com/apps) is available for Windows, Mac as well as a Chrome extension.\n\nFor each API in the overview section you will notice a **Run in Postman** button like the one below that will import the Athletes API collection into Postman.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/89a09fd2262c0beaf2c7)\n\nUpon importing the collection you will be greeted with a screen similar to the below. Note that on the left pane you will see all 13 available requests to the Athlete API available and choosing _Athlete Listings_ for example and expanding the _Params_ button you will see all available parameters that may be set.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5d2b22a-postman.png\",\n        \"postman.png\",\n        1185,\n        672,\n        \"#3f3f3f\"\n      ],\n      \"sizing\": \"full\",\n      \"border\": true,\n      \"caption\": \"Importing the Athlete API to Postman\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Adding Authentication Information\"\n}\n[/block]\nIn order to access the API you will need to add your API key obtained from the [Application Management Portal](https://apps.api.triathlon.org/login) of the API. Postman has been configured as above to send the required header of _apikey_ by using a [Postman environment variable](https://www.getpostman.com/docs/environments) to save you adding the authentication information to each request. It is suggested you add a **Global** environment variable of _apikey_ set to the value of your unique API key. For information on how to achieve this please see this [document](https://www.getpostman.com/docs/environments).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Available Collections\"\n}\n[/block]\nThe following collections are Postman ready and we will add the remaining APIs and a single overall collection shortly.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"API Name\",\n    \"h-1\": \"Postman Collection\",\n    \"0-0\": \"Athletes API\",\n    \"0-1\": \"[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/89a09fd2262c0beaf2c7)\",\n    \"1-0\": \"Events API\",\n    \"1-1\": \"[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/9d5a74b5be18b9a80638)\",\n    \"3-0\": \"Team API\",\n    \"3-1\": \"[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/06f318a04bcb3f2a1eac)\",\n    \"2-0\": \"Rankings API\",\n    \"2-1\": \"[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/d70842b784d917035019)\",\n    \"4-0\": \"Federation API\",\n    \"4-1\": \"[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/aba36bf33ffa44fa367d)\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"using-postman-to-explore-the-triathlon-api","type":"basic","title":"Using Postman to Explore the Triathlon API"}

Using Postman to Explore the Triathlon API


For many of the APIs there is a **Run in Postman** link that will import a predefined collection into the [Postman API client](https://www.getpostman.com/) providing a simple interface into each APIs methods as well as all parameters that are available. The [Postman app](https://www.getpostman.com/apps) is available for Windows, Mac as well as a Chrome extension. For each API in the overview section you will notice a **Run in Postman** button like the one below that will import the Athletes API collection into Postman. [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/89a09fd2262c0beaf2c7) Upon importing the collection you will be greeted with a screen similar to the below. Note that on the left pane you will see all 13 available requests to the Athlete API available and choosing _Athlete Listings_ for example and expanding the _Params_ button you will see all available parameters that may be set. [block:image] { "images": [ { "image": [ "https://files.readme.io/5d2b22a-postman.png", "postman.png", 1185, 672, "#3f3f3f" ], "sizing": "full", "border": true, "caption": "Importing the Athlete API to Postman" } ] } [/block] [block:api-header] { "type": "basic", "title": "Adding Authentication Information" } [/block] In order to access the API you will need to add your API key obtained from the [Application Management Portal](https://apps.api.triathlon.org/login) of the API. Postman has been configured as above to send the required header of _apikey_ by using a [Postman environment variable](https://www.getpostman.com/docs/environments) to save you adding the authentication information to each request. It is suggested you add a **Global** environment variable of _apikey_ set to the value of your unique API key. For information on how to achieve this please see this [document](https://www.getpostman.com/docs/environments). [block:api-header] { "type": "basic", "title": "Available Collections" } [/block] The following collections are Postman ready and we will add the remaining APIs and a single overall collection shortly. [block:parameters] { "data": { "h-0": "API Name", "h-1": "Postman Collection", "0-0": "Athletes API", "0-1": "[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/89a09fd2262c0beaf2c7)", "1-0": "Events API", "1-1": "[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/9d5a74b5be18b9a80638)", "3-0": "Team API", "3-1": "[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/06f318a04bcb3f2a1eac)", "2-0": "Rankings API", "2-1": "[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/d70842b784d917035019)", "4-0": "Federation API", "4-1": "[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/aba36bf33ffa44fa367d)" }, "cols": 2, "rows": 5 } [/block]