{"_id":"588f722bbcace50f0052b9ea","parentDoc":null,"user":"565f3941ea46251700972783","__v":0,"category":{"_id":"588f722bbcace50f0052b9e2","__v":0,"version":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-03T19:46:10.966Z","from_sync":false,"order":0,"slug":"introduction","title":"Getting Started"},"project":"565f5fa26bafd40d0030a064","version":{"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","__v":1,"createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"updates":["57ea87d26b8ec33200f63a79"],"next":{"pages":[],"description":""},"createdAt":"2015-12-09T21:23:21.943Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The process for creating new APIs and Proxy Endpoints in nanoscale.io can be broken down into two general flows:\n \n1. Creating overall API container and supporting components for a Proxy Endpoint, which include at least a Host,  an Environment, optional Groups, and optional Remote Endpoints if you want to call data sources\n \n2. Creating the Proxy Endpoint and corresponding workflow business logic that determines how nanoscale.io responds to requests that invoke the endpoint route\n \nThe flow charts below describe the recommended sequence of steps in the API and Proxy Endpoint creation processes.\n\n## API Creation Process Flow\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/DOyc8LWsSjWxulGYEEge_user-guide-api-creation-process-flow-diagram.png\",\n        \"user-guide-api-creation-process-flow-diagram.png\",\n        \"732\",\n        \"540\",\n        \"#c77a40\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n## Proxy Endpoints Creation Process Flow\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/lchWguJhS2eObRJwWNjs_user-guide-proxy-endpoints-creation-process-flow-diagram.png\",\n        \"user-guide-proxy-endpoints-creation-process-flow-diagram.png\",\n        \"697\",\n        \"535\",\n        \"#bb6f37\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe remainder of this guide explains how to perform each step in the process flows above. You can follow the steps in these flows and corresponding instructions in the rest of the guide to learn how to use nanoscale.io. Also, the JavaScript Object Reference provides more information on what objects can be accessed from within the JavaScript logic blocks of each Workflow Component.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The Sample APIs included with the nanoscale.io package is a good way to familiarize yourself with the product. The [Quick Start Guide](doc:quick-start-guide) is a good place to start.\",\n  \"title\": \"Sample APIs\"\n}\n[/block]","excerpt":"","slug":"api-creation-workflow","type":"basic","title":"API Creation Workflow"}

API Creation Workflow


The process for creating new APIs and Proxy Endpoints in nanoscale.io can be broken down into two general flows: 1. Creating overall API container and supporting components for a Proxy Endpoint, which include at least a Host, an Environment, optional Groups, and optional Remote Endpoints if you want to call data sources 2. Creating the Proxy Endpoint and corresponding workflow business logic that determines how nanoscale.io responds to requests that invoke the endpoint route The flow charts below describe the recommended sequence of steps in the API and Proxy Endpoint creation processes. ## API Creation Process Flow [block:image] { "images": [ { "image": [ "https://files.readme.io/DOyc8LWsSjWxulGYEEge_user-guide-api-creation-process-flow-diagram.png", "user-guide-api-creation-process-flow-diagram.png", "732", "540", "#c77a40", "" ] } ] } [/block] ## Proxy Endpoints Creation Process Flow [block:image] { "images": [ { "image": [ "https://files.readme.io/lchWguJhS2eObRJwWNjs_user-guide-proxy-endpoints-creation-process-flow-diagram.png", "user-guide-proxy-endpoints-creation-process-flow-diagram.png", "697", "535", "#bb6f37", "" ] } ] } [/block] The remainder of this guide explains how to perform each step in the process flows above. You can follow the steps in these flows and corresponding instructions in the rest of the guide to learn how to use nanoscale.io. Also, the JavaScript Object Reference provides more information on what objects can be accessed from within the JavaScript logic blocks of each Workflow Component. [block:callout] { "type": "info", "body": "The Sample APIs included with the nanoscale.io package is a good way to familiarize yourself with the product. The [Quick Start Guide](doc:quick-start-guide) is a good place to start.", "title": "Sample APIs" } [/block]