{"_id":"56a0bda03697d80d002ac5f4","category":{"_id":"56b098da8f7a4f0d0029dd10","pages":["56b0c05c0f5f980d0059fb91"],"version":"56a0bd9e3697d80d002ac5e7","__v":1,"project":"54774d9af3736008009e9e0e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-02T11:54:02.535Z","from_sync":false,"order":11,"slug":"syncano-basics","title":"Syncano Basics"},"__v":10,"user":"54774c47f3736008009e9e0c","version":{"_id":"56a0bd9e3697d80d002ac5e7","project":"54774d9af3736008009e9e0e","__v":20,"createdAt":"2016-01-21T11:14:38.131Z","releaseDate":"2016-01-21T11:14:38.131Z","categories":["56a0bd9f3697d80d002ac5e8","56a0bd9f3697d80d002ac5e9","56a0bd9f3697d80d002ac5ea","56a0bd9f3697d80d002ac5eb","56b098a43a5b810d00745e3f","56b098da8f7a4f0d0029dd10","56d5a8ecf612b80b00fb69cd","570989853ab43c0e0072b2d6","571006aa10300c0e007f6133","5735a52431a73b1700887ca0","5744b0529e045c0e00b7a7a2","5744b1d0b56d431700d8a4fb","5744b1fb55d65a0e00b436e1","5744b218f9c7411700ce560e","5744b220f9c7411700ce560f","5744b2259e045c0e00b7a7a7","5744b22cf8b79f0e00de6a2d","5744b23155d65a0e00b436e4","5744b242c758290e00fbc235","5744b2569e045c0e00b7a7a8","5756a3f2bb92962900dafe3d","57ee23e81e42900e0014a42f","581c822c98676e0f00d240ef"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Sockets","version_clean":"1.1.0","version":"1.1"},"project":"54774d9af3736008009e9e0e","parentDoc":null,"updates":["5540072c6a7d010d0057c9b7"],"next":{"pages":[],"description":""},"createdAt":"2015-04-27T06:16:13.533Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Sections:\n1. [Sign up](#sign-up)\n2. [Adding an Instance](#adding-an-instance)\n3. [Getting an API Key](#getting-an-api-key)\n4. [Connecting from a Library](#connecting-from-a-library)\n5. [Where to go next](#where-to-go-next)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sign up\"\n}\n[/block]\nTo create an account in Syncano follow these steps:\n\n1. Go to this website: [https://dashboard.syncano.io/#signup](https://dashboard.syncano.io/#signup)\n2. Type in your email address\n3. Type in the password you would like to use to access Syncano\n4. Click on 'Create My Account' button\n5. Confirm your account creation by clicking the URL in an e-mail you receive from us\n \nYou can also use an external service to sign up/log in. Currently we support:\n\n+ Google\n+ Facebook\n+ Github \n\nTo create an account using one of these services, just click on the specific social sign up button of your choice. \n​\nDid we miss your favorite service? [send us an email](mailto:hello:::at:::syncano.com) and let us know!\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Adding an Instance\"\n}\n[/block]\nOnce you have clicked on the activation url, you'll be redirected to Admin Dashboard. Here is where all of your *instances* will be. You can think of instances as projects. When creating a new instance you are creating a new project in Syncano. You can create a new instance by following the steps in the image below. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/xhhSNFIKTeGgQikhG6xW_add_instance_0.png\",\n        \"add_instance_0.png\",\n        \"1439\",\n        \"749\",\n        \"#254472\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/MgesZaqWTRu15OvwbkO9_add_instance_1.png\",\n        \"add_instance_1.png\",\n        \"1278\",\n        \"658\",\n        \"#ee4a3e\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Since an Instance can be shared between Syncano Admins, Instance names have to be unique across all accounts.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Limits\",\n  \"body\": \"Maximum number of Instances that an administrator can be an owner of is `16`\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting an API Key\"\n}\n[/block]\nWhen accessing an instance in the Syncano API, you can use API Keys that belong to that instance. You can find them by clicking on the instance, and then clicking the API keys selection as shown in the picture below. Here, you can add new API keys to that instance as well as view all existing keys. \n\nWhen trying to connect to an instance with one of our libraries, the API key is passed as a parameter and serves as the password for connecting to your instance. There is more on that right ahead. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/My85o8B5TMywgxxnmeCh_Get_API_Key.png\",\n        \"Get_API_Key.png\",\n        \"1280\",\n        \"656\",\n        \"#264472\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Connecting from a Library\"\n}\n[/block]\nOnce you have your API Key, you can connect from the library of your choice:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# In cURL, you have to pass API Key with every call you make, so e.g. to list instances associated with API Key, you can use\\n\\ncurl -X GET \\\\\\n-H \\\"X-API-KEY: <API_KEY>\\\" \\\\\\n\\\"https://api.syncano.io/v1.1/instances/\\\"\",\n      \"language\": \"curl\"\n    },\n    {\n      \"code\": \"import syncano\\nsyncano.connect(api_key='API_KEY')\\n\\n# returns a registry object. \",\n      \"language\": \"python\"\n    },\n    {\n      \"code\": \"var Syncano = require('syncano'); //Common JS only\\nvar syncano = new Syncano({apiKey:'API_KEY', instance:'INSTANCE_NAME'});\\n\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"new SyncanoBuilder().apiKey(\\\"YOUR API KEY\\\").instanceName(\\\"YOUR INSTANCE\\\")\\n     .androidContext(context).setAsGlobalInstance(true).build();\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"#import <Syncano.h>\\n//...\\nSyncano *myInstance = [Syncano sharedInstanceWithApiKey:@\\\"YOUR_API_KEY\\\" instanceName:@\\\"INSTANCE_NAME\\\"];\\n// interact with your Instance!\",\n      \"language\": \"objectivec\"\n    },\n    {\n      \"code\": \"//in bridging header\\n#import <Syncano.h>\\n\\n//in your class file\\nlet myInstance = Syncano.sharedInstanceWithApiKey(\\\"YOUR_API_KEY\\\", instanceName: \\\"INSTANCE_NAME\\\")\\n// interact with your Instance!\",\n      \"language\": \"objectivec\",\n      \"name\": \"Swift\"\n    },\n    {\n      \"code\": \"require 'syncano'\\n\\nconnection = Syncano.connect(api_key: 'YOUR_API_KEY')\",\n      \"language\": \"ruby\"\n    },\n    {\n      \"code\": \"syncano = SyncanoClient.Instance.Init(\\\"API_KEY\\\", \\\"INSTANCE_NAME\\\");\",\n      \"language\": \"csharp\",\n      \"name\": \"Unity\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Where to go next\"\n}\n[/block]\n\n* You can check out available [Syncano Libraries](doc:syncano-libraries) \n* You can test the Syncano API in the [HTTP API Reference](http://docs.syncano.com/v0.1.1) section.\n* To get a deeper understanding of Syncano concepts you can go through the chapters in the developer manual.","excerpt":"In this chapter you will learn the basic steps of how to get up and running on Syncano","slug":"getting-started-with-syncano","type":"basic","title":"Getting Started With Syncano"}

Getting Started With Syncano

In this chapter you will learn the basic steps of how to get up and running on Syncano

Sections: 1. [Sign up](#sign-up) 2. [Adding an Instance](#adding-an-instance) 3. [Getting an API Key](#getting-an-api-key) 4. [Connecting from a Library](#connecting-from-a-library) 5. [Where to go next](#where-to-go-next) [block:api-header] { "type": "basic", "title": "Sign up" } [/block] To create an account in Syncano follow these steps: 1. Go to this website: [https://dashboard.syncano.io/#signup](https://dashboard.syncano.io/#signup) 2. Type in your email address 3. Type in the password you would like to use to access Syncano 4. Click on 'Create My Account' button 5. Confirm your account creation by clicking the URL in an e-mail you receive from us You can also use an external service to sign up/log in. Currently we support: + Google + Facebook + Github To create an account using one of these services, just click on the specific social sign up button of your choice. ​ Did we miss your favorite service? [send us an email](mailto:[email protected]) and let us know! [block:api-header] { "type": "basic", "title": "Adding an Instance" } [/block] Once you have clicked on the activation url, you'll be redirected to Admin Dashboard. Here is where all of your *instances* will be. You can think of instances as projects. When creating a new instance you are creating a new project in Syncano. You can create a new instance by following the steps in the image below. [block:image] { "images": [ { "image": [ "https://files.readme.io/xhhSNFIKTeGgQikhG6xW_add_instance_0.png", "add_instance_0.png", "1439", "749", "#254472", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/MgesZaqWTRu15OvwbkO9_add_instance_1.png", "add_instance_1.png", "1278", "658", "#ee4a3e", "" ] } ] } [/block] [block:callout] { "type": "warning", "body": "Since an Instance can be shared between Syncano Admins, Instance names have to be unique across all accounts." } [/block] [block:callout] { "type": "info", "title": "Limits", "body": "Maximum number of Instances that an administrator can be an owner of is `16`" } [/block] [block:api-header] { "type": "basic", "title": "Getting an API Key" } [/block] When accessing an instance in the Syncano API, you can use API Keys that belong to that instance. You can find them by clicking on the instance, and then clicking the API keys selection as shown in the picture below. Here, you can add new API keys to that instance as well as view all existing keys. When trying to connect to an instance with one of our libraries, the API key is passed as a parameter and serves as the password for connecting to your instance. There is more on that right ahead. [block:image] { "images": [ { "image": [ "https://files.readme.io/My85o8B5TMywgxxnmeCh_Get_API_Key.png", "Get_API_Key.png", "1280", "656", "#264472", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Connecting from a Library" } [/block] Once you have your API Key, you can connect from the library of your choice: [block:code] { "codes": [ { "code": "# In cURL, you have to pass API Key with every call you make, so e.g. to list instances associated with API Key, you can use\n\ncurl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/\"", "language": "curl" }, { "code": "import syncano\nsyncano.connect(api_key='API_KEY')\n\n# returns a registry object. ", "language": "python" }, { "code": "var Syncano = require('syncano'); //Common JS only\nvar syncano = new Syncano({apiKey:'API_KEY', instance:'INSTANCE_NAME'});\n", "language": "javascript" }, { "code": "new SyncanoBuilder().apiKey(\"YOUR API KEY\").instanceName(\"YOUR INSTANCE\")\n .androidContext(context).setAsGlobalInstance(true).build();", "language": "java", "name": "Android" }, { "code": "#import <Syncano.h>\n//...\nSyncano *myInstance = [Syncano sharedInstanceWithApiKey:@\"YOUR_API_KEY\" instanceName:@\"INSTANCE_NAME\"];\n// interact with your Instance!", "language": "objectivec" }, { "code": "//in bridging header\n#import <Syncano.h>\n\n//in your class file\nlet myInstance = Syncano.sharedInstanceWithApiKey(\"YOUR_API_KEY\", instanceName: \"INSTANCE_NAME\")\n// interact with your Instance!", "language": "objectivec", "name": "Swift" }, { "code": "require 'syncano'\n\nconnection = Syncano.connect(api_key: 'YOUR_API_KEY')", "language": "ruby" }, { "code": "syncano = SyncanoClient.Instance.Init(\"API_KEY\", \"INSTANCE_NAME\");", "language": "csharp", "name": "Unity" } ] } [/block] [block:api-header] { "type": "basic", "title": "Where to go next" } [/block] * You can check out available [Syncano Libraries](doc:syncano-libraries) * You can test the Syncano API in the [HTTP API Reference](http://docs.syncano.com/v0.1.1) section. * To get a deeper understanding of Syncano concepts you can go through the chapters in the developer manual.