{"__v":12,"_id":"54dcc396db3b36210013121a","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Protocol Support\"\n}\n[/block]\n\nThe Yotpo API supports both HTTP and HTTPS requests.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Data Format\"\n}\n[/block]\nYou need to send data as JSON. \nThis means that you need to include the HTTP header Content-Type: application/json \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Pagination\"\n}\n[/block]\nIn requests which support pagination, use the following parameters to paginate through the results:\n  * page - number of page to return\n  * count - number of results to return per page\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Status Code\"\n}\n[/block]\nYotpo API uses standard HTTP response codes to show the status – success or failure of an API Request:\n  * 200 for successful responses\n  * 401 for unauthorized requests \n  * 500 for Internal server Errors, such as timeout\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note:\",\n  \"body\": \"Some API calls also have special responses to indicate specific errors. See the relevant API document.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nYotpo uses tokens to authenticate and authorize an account. Tokens are generated by an API call that uses the client ID and client secret. See the Token API Reference Guide.\nA token is required in non-public API calls to ensure private account data is accessible only by authorized users.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note:\",\n  \"body\": \"Each token expires after 14 days since creation and will no longer be useable.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Parameters\"\n}\n[/block]\nEmail and URL parameters you send in the calls must be in the correct format, otherwise the call will not be processed.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Format\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"email\",\n    \"0-1\": \"user:::at:::domain\",\n    \"0-2\": \"jsmith@yotpo.com\",\n    \"1-0\": \"url\",\n    \"1-1\": \"http://www.domain/full path of resource\",\n    \"1-2\": \"http://www.gkshops.com/USBthingy.html\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"UTF-8 Support\"\n}\n[/block]\nThe Yotpo API calls support special characters according to the UTF-8 coding.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Finding Your API Key (Appkey)\"\n}\n[/block]\n1. Log in to your Yotpo Admin page.\n2. Choose Settings under the User Settings menu (or Account Settings menu if you are using the new Yotpo Admin).\n3. Click Store Settings.\n4. Scroll down to API Credentials.\n\n* Your App Key is the API key.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The \\\"validate_data\\\" parameter\"\n}\n[/block]\nWhen set to \"true\", this parameter provides additional data validation, prior to sending it to the API pipe for selected Purchases API calls.\nIt is recommended to set this to true, as it may catch errors that are otherwise missed.","category":"54dcc21204fd850d0014c5ef","createdAt":"2015-02-12T15:15:34.591Z","excerpt":"This page contains general information about Yotpo API calls.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"548ee4ccff3cbe0b00e77c30","slug":"general-information","sync_unique":"","title":"Read Me First","type":"basic","updates":[],"user":"548fd4f062045414001a373a","version":"548ee4ccff3cbe0b00e77c33","childrenPages":[]}

Read Me First

This page contains general information about Yotpo API calls.

[block:api-header] { "type": "basic", "title": "Protocol Support" } [/block] The Yotpo API supports both HTTP and HTTPS requests. [block:api-header] { "type": "basic", "title": "Data Format" } [/block] You need to send data as JSON. This means that you need to include the HTTP header Content-Type: application/json [block:api-header] { "type": "basic", "title": "Pagination" } [/block] In requests which support pagination, use the following parameters to paginate through the results: * page - number of page to return * count - number of results to return per page [block:api-header] { "type": "basic", "title": "Status Code" } [/block] Yotpo API uses standard HTTP response codes to show the status – success or failure of an API Request: * 200 for successful responses * 401 for unauthorized requests * 500 for Internal server Errors, such as timeout [block:callout] { "type": "info", "title": "Note:", "body": "Some API calls also have special responses to indicate specific errors. See the relevant API document." } [/block] [block:api-header] { "type": "basic", "title": "Authentication" } [/block] Yotpo uses tokens to authenticate and authorize an account. Tokens are generated by an API call that uses the client ID and client secret. See the Token API Reference Guide. A token is required in non-public API calls to ensure private account data is accessible only by authorized users. [block:callout] { "type": "info", "title": "Note:", "body": "Each token expires after 14 days since creation and will no longer be useable." } [/block] [block:api-header] { "type": "basic", "title": "Parameters" } [/block] Email and URL parameters you send in the calls must be in the correct format, otherwise the call will not be processed. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Format", "h-2": "Example", "0-0": "email", "0-1": "user@domain", "0-2": "jsmith@yotpo.com", "1-0": "url", "1-1": "http://www.domain/full path of resource", "1-2": "http://www.gkshops.com/USBthingy.html" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "UTF-8 Support" } [/block] The Yotpo API calls support special characters according to the UTF-8 coding. [block:api-header] { "type": "basic", "title": "Finding Your API Key (Appkey)" } [/block] 1. Log in to your Yotpo Admin page. 2. Choose Settings under the User Settings menu (or Account Settings menu if you are using the new Yotpo Admin). 3. Click Store Settings. 4. Scroll down to API Credentials. * Your App Key is the API key. [block:api-header] { "type": "basic", "title": "The \"validate_data\" parameter" } [/block] When set to "true", this parameter provides additional data validation, prior to sending it to the API pipe for selected Purchases API calls. It is recommended to set this to true, as it may catch errors that are otherwise missed.