{"_id":"55fc9b813c21291900e7e109","user":"5553d33065e8260d00244199","version":{"_id":"55fc9b793c21291900e7e0d7","__v":12,"project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"parentDoc":null,"category":{"_id":"55fc9b7a3c21291900e7e0da","pages":["55fc9b813c21291900e7e109","55fc9b813c21291900e7e10a","55fc9b813c21291900e7e10b","55fc9b813c21291900e7e10c","55fc9b813c21291900e7e10d","55fc9b813c21291900e7e10e","55fc9b813c21291900e7e10f"],"project":"5553d36165e8260d0024419a","__v":1,"version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-13T22:52:06.479Z","from_sync":false,"order":2,"slug":"creating-api-calls","title":"Creating API Calls"},"__v":0,"project":"5553d36165e8260d0024419a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-14T20:14:22.122Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:embed]\n{\n  \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2Fvideoseries%3Flist%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DTYUTd3snynA%26index%3D2%26list%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FTYUTd3snynA%2Fhqdefault.jpg&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=youtube\\\" width=\\\"854\\\" height=\\\"480\\\" scrolling=\\\"no\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\",\n  \"url\": \"https://www.youtube.com/watch?v=TYUTd3snynA&index=2&list=PLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_\",\n  \"title\": \"APImetrics Basic Setup\",\n  \"favicon\": \"https://s.ytimg.com/yts/img/favicon-vflz7uhzw.ico\",\n  \"image\": \"https://i.ytimg.com/vi/TYUTd3snynA/hqdefault.jpg\"\n}\n[/block]\nThere are several ways to quickly add an API call:\n- Enter a URI into the form at the top of your Dashboard\n- Click +API Call from the 'API Management' drop down\n- Enter a URI in the API Call list\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/UEzcjd9WSFeHLc0LSNdr_create_api.png\",\n        \"create_api.png\",\n        \"978\",\n        \"95\",\n        \"#3f4495\",\n        \"\"\n      ],\n      \"caption\": \"Add a new API Call\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URI's for API Calls\"\n}\n[/block]\nEnter the URI for the API call you intend to make.  If the call has been made previously, or shared with our public community then we'll pick that up at this stage.\n\nURI will probably take the format of:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.example.com/something/something/\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nClick 'Add' and the call setup will be saved.\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Call Setup\"\n}\n[/block]\nWhen you click Next, we'll generate a Call ID, which you can change and be taken to the call set up screen.\n\nSelect the REST method from the drop down.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2iNls8nkRDaXrMN0cv2y_methods.png\",\n        \"methods.png\",\n        \"253\",\n        \"195\",\n        \"#354a6a\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/mdpwK4xlSveJ25b3VjCQ_test_edit.png\",\n        \"test_edit.png\",\n        \"787\",\n        \"522\",\n        \"#516997\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nClicking the URI Parameters button will allow you to add parameters to the query.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Add Authentication\"\n}\n[/block]\nSee [here](doc:authentication-setup) for a full description of how API authentication works.\n\nYou can either select the appropriate Authentication settings from the drop down menu, or click the green '+' sign to create a new authentication setting.\n\nYou can then select a token from the Token drop down, \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Next Steps\"\n}\n[/block]\nOnce complete, you can save the call and run it.","excerpt":"","slug":"using-the-api-wizard","type":"basic","title":"Creating an API Call"}

Creating an API Call


[block:embed] { "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2Fvideoseries%3Flist%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DTYUTd3snynA%26index%3D2%26list%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FTYUTd3snynA%2Fhqdefault.jpg&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>", "url": "https://www.youtube.com/watch?v=TYUTd3snynA&index=2&list=PLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_", "title": "APImetrics Basic Setup", "favicon": "https://s.ytimg.com/yts/img/favicon-vflz7uhzw.ico", "image": "https://i.ytimg.com/vi/TYUTd3snynA/hqdefault.jpg" } [/block] There are several ways to quickly add an API call: - Enter a URI into the form at the top of your Dashboard - Click +API Call from the 'API Management' drop down - Enter a URI in the API Call list [block:image] { "images": [ { "image": [ "https://files.readme.io/UEzcjd9WSFeHLc0LSNdr_create_api.png", "create_api.png", "978", "95", "#3f4495", "" ], "caption": "Add a new API Call" } ] } [/block] [block:api-header] { "type": "basic", "title": "URI's for API Calls" } [/block] Enter the URI for the API call you intend to make. If the call has been made previously, or shared with our public community then we'll pick that up at this stage. URI will probably take the format of: [block:code] { "codes": [ { "code": "https://api.example.com/something/something/", "language": "text" } ] } [/block] Click 'Add' and the call setup will be saved. [block:api-header] { "type": "basic", "title": "API Call Setup" } [/block] When you click Next, we'll generate a Call ID, which you can change and be taken to the call set up screen. Select the REST method from the drop down. [block:image] { "images": [ { "image": [ "https://files.readme.io/2iNls8nkRDaXrMN0cv2y_methods.png", "methods.png", "253", "195", "#354a6a", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/mdpwK4xlSveJ25b3VjCQ_test_edit.png", "test_edit.png", "787", "522", "#516997", "" ] } ] } [/block] Clicking the URI Parameters button will allow you to add parameters to the query. [block:api-header] { "type": "basic", "title": "Add Authentication" } [/block] See [here](doc:authentication-setup) for a full description of how API authentication works. You can either select the appropriate Authentication settings from the drop down menu, or click the green '+' sign to create a new authentication setting. You can then select a token from the Token drop down, [block:api-header] { "type": "basic", "title": "Next Steps" } [/block] Once complete, you can save the call and run it.