{"id":51001,"date":"2016-06-03T15:43:28","date_gmt":"2016-06-03T15:43:28","guid":{"rendered":"http:\/\/webkul.com\/blog\/?p=51001"},"modified":"2024-04-04T13:23:09","modified_gmt":"2024-04-04T13:23:09","slug":"use-opencarts-rest-api","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/","title":{"rendered":"How to use OpenCart’s Rest API?"},"content":{"rendered":"

As OpenCart already provides the REST API<\/a> so we need to learn how to use the API. This is very helpful in order to use a store’s functionality from different devices irrespective of technology.<\/p>\n

In order to start, we have to add a new API. For that, we have to visit System->Users->API from the admin panel.<\/p>\n

\"addapi\"
After clicking the add button, we will get into a form where we have to provide API name and API Key. The API key can be generated automatically after clicking on generate button.<\/p>\n

\"apikey\"
After creating the API Key, we have login into the OpenCart API using the created API key. Here, I will tell you about the login part. We will discuss over the other files in further posts.<\/p>\n

In the folder catalog->controller->api, we have several files containing APIs. We have to log-in first, so need to access the\u00a0login.php file.<\/p>\n

We used curl to access the API. The code below will provide you the process of writing flat PHP code to access the API.<\/p>\n

<?php\n\n\t$url = \"http:\/\/my-opencart.com\/index.php?route=api\/login\";\n\t$params = array(\n\t\t'key=IENkO5W3VN2vKCEXYO4L6g3zGxM6LC1WdrylZF86gWSjgrBn80jHrIFcysXVCkJeoX1q8YEKwdT7eyaTN8MHSca41kXDpMtf53nN6npVEOOtK6ZL3LEn5eMO4Zj4bPdb14c22iaQJEBB2Lkl0Ef2AzXfdtwhyykDRZXqmVbEHweGkif353u0vdthYSqQtbXZWWD3LceyDUuuI8YGPZ5eflIes8SjM48sCw3h1mZj8w6hGSI1o6TOpuFAs6xjGpkc'\n\t\t); \/\/ this array can contain the any number of parameter you need to send\n\n\t$parameters = implode('&', $params);\n\n\t$ch = curl_init();\n\tcurl_setopt($ch,CURLOPT_URL, $url);\n\tcurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\n\n\tcurl_setopt($ch,CURLOPT_POST, $parameter_count);\n\tcurl_setopt($ch,CURLOPT_POSTFIELDS, $parameters);\n\n\t\/\/execute post\n\t$result = curl_exec($ch);\n\n\t\/\/close connection\n\tcurl_close($ch);\n\n\tprint_r($result);\n?><\/pre>\n
If we run this code, then\u00a0it will return a JSON\u00a0object.<\/p>\n
On incorrect API Key:<\/p>\n
\"incorrectkey\"<\/p>\n
On correct API Key:<\/p>\n
\"correctkey\"
The token return from the login API is required in order to access other APIs. We will discuss more on OpenCart API development<\/a>. Thanks \ud83d\ude42<\/p>\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
As OpenCart already provides the REST API so we need to learn how to use the API. This is very helpful in order to use a store’s functionality from different devices irrespective of technology. In order to start, we have to add a new API. For that, we have to visit System->Users->API from the admin […]<\/a><\/p>\n","protected":false},"author":70,"featured_media":41008,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1173,305],"tags":[292,3205,2071,2253],"class_list":["post-51001","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-api-2","category-opencart","tag-api","tag-curl","tag-opencart","tag-rest-api"],"yoast_head":"\nHow to Use OpenCart's Rest API | API Development - Webkul Blog<\/title>\n<meta name=\"description\" content=\"As OpenCart already provides the REST API so we need to learn how to use the API. We will discuss over the other files in further posts.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to Use OpenCart's Rest API | API Development - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"As OpenCart already provides the REST API so we need to learn how to use the API. We will discuss over the other files in further posts.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2016-06-03T15:43:28+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-04-04T13:23:09+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png\" \/>\n\t<meta property=\"og:image:width\" content=\"825\" \/>\n\t<meta property=\"og:image:height\" content=\"260\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Vikhyat Sharma\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Vikhyat Sharma\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\"},\"author\":{\"name\":\"Vikhyat Sharma\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/af7160d2546c64a1856ab1b5ce77d9b0\"},\"headline\":\"How to use OpenCart’s Rest API?\",\"datePublished\":\"2016-06-03T15:43:28+00:00\",\"dateModified\":\"2024-04-04T13:23:09+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\"},\"wordCount\":230,\"commentCount\":11,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png\",\"keywords\":[\"api\",\"curl\",\"opencart\",\"REST API\"],\"articleSection\":[\"API\",\"opencart\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\",\"url\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\",\"name\":\"How to Use OpenCart's Rest API | API Development - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png\",\"datePublished\":\"2016-06-03T15:43:28+00:00\",\"dateModified\":\"2024-04-04T13:23:09+00:00\",\"description\":\"As OpenCart already provides the REST API so we need to learn how to use the API. We will discuss over the other files in further posts.\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png\",\"width\":825,\"height\":260},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to use OpenCart’s Rest API?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/af7160d2546c64a1856ab1b5ce77d9b0\",\"name\":\"Vikhyat Sharma\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/7c9c700cc2d7120c9faf1ab3392b4e533808ba197f58c0441d6caecc68179e12?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/7c9c700cc2d7120c9faf1ab3392b4e533808ba197f58c0441d6caecc68179e12?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Vikhyat Sharma\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/vikhyat-sharma83\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to Use OpenCart's Rest API | API Development - Webkul Blog","description":"As OpenCart already provides the REST API so we need to learn how to use the API. We will discuss over the other files in further posts.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/","og_locale":"en_US","og_type":"article","og_title":"How to Use OpenCart's Rest API | API Development - Webkul Blog","og_description":"As OpenCart already provides the REST API so we need to learn how to use the API. We will discuss over the other files in further posts.","og_url":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2016-06-03T15:43:28+00:00","article_modified_time":"2024-04-04T13:23:09+00:00","og_image":[{"width":825,"height":260,"url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png","type":"image\/png"}],"author":"Vikhyat Sharma","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Vikhyat Sharma","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/"},"author":{"name":"Vikhyat Sharma","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/af7160d2546c64a1856ab1b5ce77d9b0"},"headline":"How to use OpenCart’s Rest API?","datePublished":"2016-06-03T15:43:28+00:00","dateModified":"2024-04-04T13:23:09+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/"},"wordCount":230,"commentCount":11,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage"},"thumbnailUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png","keywords":["api","curl","opencart","REST API"],"articleSection":["API","opencart"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/","url":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/","name":"How to Use OpenCart's Rest API | API Development - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage"},"thumbnailUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png","datePublished":"2016-06-03T15:43:28+00:00","dateModified":"2024-04-04T13:23:09+00:00","description":"As OpenCart already provides the REST API so we need to learn how to use the API. We will discuss over the other files in further posts.","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2016\/02\/Opencart-Code-Snippet.png","width":825,"height":260},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/use-opencarts-rest-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to use OpenCart’s Rest API?"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/af7160d2546c64a1856ab1b5ce77d9b0","name":"Vikhyat Sharma","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/7c9c700cc2d7120c9faf1ab3392b4e533808ba197f58c0441d6caecc68179e12?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/7c9c700cc2d7120c9faf1ab3392b4e533808ba197f58c0441d6caecc68179e12?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Vikhyat Sharma"},"url":"https:\/\/webkul.com\/blog\/author\/vikhyat-sharma83\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/51001","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/70"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=51001"}],"version-history":[{"count":10,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/51001\/revisions"}],"predecessor-version":[{"id":431823,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/51001\/revisions\/431823"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media\/41008"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=51001"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=51001"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=51001"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}