{"_id":"55ec2396ab05791700686a7c","updates":[],"createdAt":"2015-09-06T11:29:26.022Z","order":0,"slug":"getting-started","title":"Getting Started","version":"55ec2394ab05791700686a79","body":"The Youzign API lets you:\n\n- retrieve user designs\n- get user designs data\n- authenticate via secure API credentials\n- insert designs into your app\n- view design changes made on Youzign in real time","excerpt":"Welcome to the Youzign API! On average integrating with Youzign takes less than a day!","githubsync":"","project":"55ec2394ab05791700686a76","sync_unique":"","__v":15,"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"link_external":false,"link_url":"","type":"basic","category":"55ec2395ab05791700686a7a","hidden":false,"user":"55ec2212fe9cef210018bb11","childrenPages":[]}

Getting Started

Welcome to the Youzign API! On average integrating with Youzign takes less than a day!

The Youzign API lets you: - retrieve user designs - get user designs data - authenticate via secure API credentials - insert designs into your app - view design changes made on Youzign in real time
The Youzign API lets you: - retrieve user designs - get user designs data - authenticate via secure API credentials - insert designs into your app - view design changes made on Youzign in real time
{"_id":"55ec312b1f9135170088ae2d","excerpt":"","link_external":false,"githubsync":"","link_url":"","order":1,"project":"55ec2394ab05791700686a76","api":{"url":"/","auth":"required","examples":{"codes":[{"language":"text","code":""}]},"method":"post","params":[{"_id":"55f179c67dccfc0d00986b14","default":"","desc":"(required) Public Key as generated in Youzign profile.","name":"key","required":false,"type":"string","in":"body"},{"default":"","desc":"(required) Token as generated in Youzign profile.","name":"token","required":false,"type":"string","in":"body","_id":"55f179c67dccfc0d00986b13"}],"results":{"codes":[{"code":"Successful authentication.\n\n{\n  \"authenticated\": \"123\" // integer\n}","language":"json","name":"Success"},{"code":"Missing token or private key.\n\n{\n  \"error\": \"You must specify a token and API key!\"\n}\n\nInvalid API key.\n\n{\n  \"error\": \"Invalid API key!\"\n}\n\nInvalid autghentication.\n\n{\n  \"error\": \"Your request could not be authenticated!\"\n}","language":"json","name":"Failure"}]},"settings":""},"category":"55ec2395ab05791700686a7a","editedParams":true,"editedParams2":true,"sync_unique":"","version":"55ec2394ab05791700686a79","slug":"authentification","title":"Authentification","type":"post","updates":[],"user":"55ec2212fe9cef210018bb11","__v":22,"body":"Users should authenticate to the Youzign API by providing their Public API Key and Token in the request.  \n\n## API Keys\n\nUsers can retrieve their API keys from their Youzign profile page (accessible on https://youzign.com/profile).\n\n## Sample Credentials\nHere are some sample credentials from a demo account, feel free to use these to test your integration.\n\nPublic Key: 5077d4ed60da38255c2c71421ddac36f\nToken: 55f772fcdae50ce0caee3986112621a3","createdAt":"2015-09-06T12:27:23.291Z","hidden":false,"childrenPages":[]}

postAuthentification


Body Params

key:
string
(required) Public Key as generated in Youzign profile.
token:
string
(required) Token as generated in Youzign profile.
Users should authenticate to the Youzign API by providing their Public API Key and Token in the request. ## API Keys Users can retrieve their API keys from their Youzign profile page (accessible on https://youzign.com/profile). ## Sample Credentials Here are some sample credentials from a demo account, feel free to use these to test your integration. Public Key: 5077d4ed60da38255c2c71421ddac36f Token: 55f772fcdae50ce0caee3986112621a3

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Users should authenticate to the Youzign API by providing their Public API Key and Token in the request. ## API Keys Users can retrieve their API keys from their Youzign profile page (accessible on https://youzign.com/profile). ## Sample Credentials Here are some sample credentials from a demo account, feel free to use these to test your integration. Public Key: 5077d4ed60da38255c2c71421ddac36f Token: 55f772fcdae50ce0caee3986112621a3
{"_id":"55ec40a4fe9cef210018bb20","sync_unique":"","updates":["56dd65b50c3bb41700b0b02f","56dd667cefaca42900e5f58c","56dd67aa0c3bb41700b0b033","56dd6a3af658a919000f39dc"],"body":"","githubsync":"","isReference":false,"project":"55ec2394ab05791700686a76","link_url":"","slug":"public-key-and-token","type":"post","version":"55ec2394ab05791700686a79","api":{"params":[{"name":"page","required":false,"type":"int","in":"body","_id":"55f184545fe76419007dc701","default":"1","desc":"(optional) Page number."},{"default":"-1","desc":"(optional) Number of items to be returned per page. If not set or equal to -1 (default) all items are returned.","name":"per_page","required":false,"type":"int","in":"body","_id":"55f184545fe76419007dc700"},{"name":"key","in":"body","_id":"55f17f969f818e1900f00952","required":false,"desc":"(required) Public Key as generated in Youzign profile.","default":"","type":"string"},{"name":"token","in":"body","_id":"55f17f969f818e1900f00951","required":false,"desc":"(required) Token as generated in Youzign profile.","default":"","type":"string"}],"results":{"codes":[{"name":"Success","code":"[\n    {\n        \"id\": 399216,\n        \"slug\": \"test-969\",\n        \"title\": \"test\",\n        \"date\": \"2015-08-14 13:36:07\",\n        \"status\": \"publish\",\n        \"link\": \"https://www.youzign.com/designs/test-969/\",\n        \"image_src\": [\n            \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969.png\",\n            412,\n            547,\n            false\n        ],\n        \"image_sizes\": {\n            \"thumbnail\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969-150x150.png\",\n                150,\n                150,\n                true\n            ],\n            \"medium\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969-226x300.png\",\n                226,\n                300,\n                true\n            ],\n            \"large\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969.png\",\n                412,\n                547,\n                false\n            ],\n            \"user-avatar-large\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969-150x150.png\",\n                150,\n                150,\n                true\n            ],\n            \"user-avatar-small\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969-38x38.png\",\n                38,\n                38,\n                true\n            ],\n            \"design-thumb\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969-195x188.png\",\n                195,\n                188,\n                true\n            ],\n            \"design-thumb-large\": [\n                \"https://s3.amazonaws.com/userdata.youzign.com/wp-content/uploads/x/2015/08/test-969-362x480.png\",\n                362,\n                480,\n                true\n            ]\n        },\n        \"template_type\": \"Custom Size\"\n    }\n}","language":"json","status":null},{"language":"json","status":null,"name":"Failure","code":"{}"}]},"settings":"","url":"/designs/","auth":"required","method":"post"},"editedParams2":true,"hidden":false,"link_external":false,"createdAt":"2015-09-06T13:33:24.920Z","excerpt":"","title":"Designs","user":"55ec2212fe9cef210018bb11","order":2,"__v":6,"category":"55ec2395ab05791700686a7a","editedParams":true,"childrenPages":[]}

postDesigns


Body Params

page:
integer1
(optional) Page number.
per_page:
integer-1
(optional) Number of items to be returned per page. If not set or equal to -1 (default) all items are returned.
key:
string
(required) Public Key as generated in Youzign profile.
token:
string
(required) Token as generated in Youzign profile.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55f2e48fcb01c71900c8e22c","api":{"params":[{"in":"body","_id":"55f179c67dccfc0d00986b14","required":false,"desc":"(required) Public Key as generated in Youzign profile.","default":"","type":"string","name":"key"},{"type":"string","name":"token","in":"body","_id":"55f179c67dccfc0d00986b13","required":false,"desc":"(required) Token as generated in Youzign profile.","default":""}],"results":{"codes":[{"name":"Success","language":"json","code":"{\n    \"display_name\": \"youzign\",\n    \"description\": \"I'm the demo account, so Im just here to be tested, really : ) \",\n    \"avatar_url\": \"https://www.youzign.com/wp-content/themes/YouzignTheme/img/default-avatar-small.png\"\n}"},{"name":"Failure","language":"json","code":"Missing profile data.\n\n{\n  \"error\": \"Profile data not found!\"\n}"}]},"settings":"","url":"/profile/","auth":"required","examples":{"codes":[{"language":"text","code":""}]},"method":"post"},"excerpt":"","githubsync":"","editedParams":true,"editedParams2":true,"link_external":false,"type":"post","updates":[],"order":3,"slug":"profile","title":"Profile","user":"55ec2212fe9cef210018bb11","version":"55ec2394ab05791700686a79","sync_unique":"","__v":0,"body":"","category":"55ec2395ab05791700686a7a","createdAt":"2015-09-11T14:26:23.451Z","hidden":false,"link_url":"","project":"55ec2394ab05791700686a76","childrenPages":[]}

postProfile


Body Params

key:
string
(required) Public Key as generated in Youzign profile.
token:
string
(required) Token as generated in Youzign profile.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55f2ca0d71c6462100e0fd93","type":"basic","user":"55ec2212fe9cef210018bb11","githubsync":"","isReference":false,"link_url":"","project":"55ec2394ab05791700686a76","sync_unique":"","version":"55ec2394ab05791700686a79","body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Youzign Wordpress Plugin\",\n  \"body\": \"[https://wordpress.org/plugins/youzign/\\n](https://wordpress.org/plugins/youzign/)\\n(we highly recommend you download the Youzign Wordpress plugin and take a good look at the code to see how we used the API here)\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Other integrations\",\n  \"body\": \"[http://support.youzign.com/s1-general/knowledgebase/top/c5-integrations](http://support.youzign.com/s1-general/knowledgebase/top/c5-integrations)\"\n}\n[/block]","hidden":false,"link_external":false,"slug":"example-integrations","updates":["56eace62c760370e0037aaff"],"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2015-09-11T12:33:17.737Z","excerpt":"","order":4,"__v":7,"category":"55ec2395ab05791700686a7a","title":"Example integrations","childrenPages":[]}

Example integrations


[block:callout] { "type": "success", "title": "Youzign Wordpress Plugin", "body": "[https://wordpress.org/plugins/youzign/\n](https://wordpress.org/plugins/youzign/)\n(we highly recommend you download the Youzign Wordpress plugin and take a good look at the code to see how we used the API here)" } [/block] [block:callout] { "type": "success", "title": "Other integrations", "body": "[http://support.youzign.com/s1-general/knowledgebase/top/c5-integrations](http://support.youzign.com/s1-general/knowledgebase/top/c5-integrations)" } [/block]
[block:callout] { "type": "success", "title": "Youzign Wordpress Plugin", "body": "[https://wordpress.org/plugins/youzign/\n](https://wordpress.org/plugins/youzign/)\n(we highly recommend you download the Youzign Wordpress plugin and take a good look at the code to see how we used the API here)" } [/block] [block:callout] { "type": "success", "title": "Other integrations", "body": "[http://support.youzign.com/s1-general/knowledgebase/top/c5-integrations](http://support.youzign.com/s1-general/knowledgebase/top/c5-integrations)" } [/block]