{"_id":"56974f48d231880d00676e6a","githubsync":"","parentDoc":null,"category":{"_id":"569742f459a6692d003fad8f","pages":["56974f48d231880d00676e6a","56975101d231880d00676e6c","5697511369393517000c82c8","5697512159a6692d003fada0","569752668560a60d00e2c268","569752898560a60d00e2c26b","569752add231880d00676e70","569752bd8400d52d00dd56ab","569752c769393517000c82cc","56e9cf33fae86b0e00e5394f","56e9cfe2af392b170035f68f"],"project":"5668fab608f90021008e882f","version":"5668fab608f90021008e8832","__v":11,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-14T06:40:52.350Z","from_sync":false,"order":1,"slug":"api-integration-rest-api","title":"REST API (For App/Backend)"},"project":"5668fab608f90021008e882f","__v":1,"user":"56839cf74aecbd0d00a4659e","version":{"_id":"5668fab608f90021008e8832","__v":19,"project":"5668fab608f90021008e882f","createdAt":"2015-12-10T04:08:22.769Z","releaseDate":"2015-12-10T04:08:22.769Z","categories":["5668fab708f90021008e8833","569740f124490c3700170a64","569742b58560a60d00e2c25d","569742bd0b09a41900b2446c","569742cd69393517000c82b3","569742f459a6692d003fad8f","569743020b09a41900b2446d","5697430b69393517000c82b5","56a17776470ae00d00c30642","56a2c48a831e2a0d0069b1ad","56b535757bccae0d00e9a1cd","56e1ff6aa49fdc0e005746b5","57e1c88115bf6522002a5e4e","57fa65275ba65a17008b988f","57fbeea34002550e004c032e","58474584889b6c2d00fb86e9","58475dcc64157f0f002f1907","587e7b5158666c2700965d4e","58a349fc30852819007ba083"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.18.0","version":"1.18"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-14T07:33:28.395Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/x423Ddg4QMKIr6Mb9Jss_Screen%20Shot%202016-01-12%20at%204.18.32%20PM.png\",\n        \"Screen Shot 2016-01-12 at 4.18.32 PM.png\",\n        \"1850\",\n        \"836\",\n        \"#323233\",\n        \"\"\n      ],\n      \"caption\": \"Note that there might be your backend between your application and LiftIgniter API endpoints if you're doing a backend integration.\"\n    }\n  ]\n}\n[/block]\nGeneral overview of our API endpoints:<ul>\n<li>`Inventory endpoint` is used to send us information about your inventory items (such as your videos, articles, or products). This is the universe of items from which we recommend. We have an [inventory POST endpoint](doc:inventory) to post inventories, an [inventory lookup GET endpoint](doc:inventoryid) to look up details of an inserted inventory item, and an [inventory DELETE endpoint](doc:inventory-1) to delete already existing inventory items.</li>\n<li>`Activity endpoint` receives activity data from user using your application. \nFor what kind of data you can send us, please refer to the [activity POST endpoint](doc:activity-1) documentation.</li>\n<li>`User endpoint` receives User data (optional) from your application. Note that this isn't required. Use it if you think that any information that you have about the user will be helpful to improving recommendations. There is a [user POST endpoint](doc:user) to post user data, a [user lookup GET endpoint](doc:userid) to look up data for an existing user, a [user DELETE endpoint](doc:user-1) to delete data about an existing user.</li>\n<li> Data from these 3 endpoints are sent to LiftIgniter, which immediately starts processing those data to update Model endpoint.</li>\n<li>`Model endpoint` returns recommendations for the user based on the context of user's current behavior. You can read about the [model POST endpoint](doc:model).</li>\n</ul>\nOur endpoints support both HTTP and HTTPS. We recommend using HTTPS for enhanced security.","excerpt":"","slug":"api-overview","type":"basic","title":"API Overview"}
[block:image] { "images": [ { "image": [ "https://files.readme.io/x423Ddg4QMKIr6Mb9Jss_Screen%20Shot%202016-01-12%20at%204.18.32%20PM.png", "Screen Shot 2016-01-12 at 4.18.32 PM.png", "1850", "836", "#323233", "" ], "caption": "Note that there might be your backend between your application and LiftIgniter API endpoints if you're doing a backend integration." } ] } [/block] General overview of our API endpoints:<ul> <li>`Inventory endpoint` is used to send us information about your inventory items (such as your videos, articles, or products). This is the universe of items from which we recommend. We have an [inventory POST endpoint](doc:inventory) to post inventories, an [inventory lookup GET endpoint](doc:inventoryid) to look up details of an inserted inventory item, and an [inventory DELETE endpoint](doc:inventory-1) to delete already existing inventory items.</li> <li>`Activity endpoint` receives activity data from user using your application. For what kind of data you can send us, please refer to the [activity POST endpoint](doc:activity-1) documentation.</li> <li>`User endpoint` receives User data (optional) from your application. Note that this isn't required. Use it if you think that any information that you have about the user will be helpful to improving recommendations. There is a [user POST endpoint](doc:user) to post user data, a [user lookup GET endpoint](doc:userid) to look up data for an existing user, a [user DELETE endpoint](doc:user-1) to delete data about an existing user.</li> <li> Data from these 3 endpoints are sent to LiftIgniter, which immediately starts processing those data to update Model endpoint.</li> <li>`Model endpoint` returns recommendations for the user based on the context of user's current behavior. You can read about the [model POST endpoint](doc:model).</li> </ul> Our endpoints support both HTTP and HTTPS. We recommend using HTTPS for enhanced security.