API module technische documentatie
Request:
--
GET /api/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71
----
Response:
--
HTTP/1.1 402 Payment RequiredContent-Type: text/json;charset=UTF-8Content-Length: 35{"Warning":"API Module not active"}
----
Toelichting:
--
Add On niet aangeschaft of verlopen
----------------------------------------
Request:
--
GET /api/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71
----
Response:
--
GET /api/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71
----
Toelichting:
--
Authenticatie onsuccesvol of niet meegegeven
----------------------------------------
Request:
--
POST /api/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71Content-Type: application/x-www-form-urlencodedContent-Length: 150
----
Response:
--
HTTP/1.1 404 Not FoundContent-Type: text/json;charset=UTF-8Content-Length: 71{"Info":"Requested resource not found or incorrect parameters passed."}
----
Toelichting:
--
Authenticatie succesvol, maar geen paramaters meegegeven.
----------------------------------------
Request:
--
POST /api/brand/get/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71Content-Type: application/x-www-form-urlencodedContent-Length: 150api_key=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A&api_secret=MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCirfGZAfwYr/RN&api_user=jaap@mijntestpartner.nl
----
Response:
--
HTTP/1.1 403 ForbiddenContent-Type: text/json;charset=UTF-8Content-Length: 70{"Error":"You have insufficient permissions to perform this request."}
----
Toelichting:
--
Authenticatie succesvol, correcte parameters meegegeven, maar niet voldoende rechten.
----------------------------------------
Request:
--
POST /api/products/get/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71Content-Type: application/x-www-form-urlencodedContent-Length: 150api_key=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A&api_secret=MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCirfGZAfwYr/RN&api_user=jaap@mijntestpartner.nl
----
Response:
--
HTTP/1.1 200 OKContent-Type: text/json;charset=UTF-8Content-Length: 6788360[ { "product_name": "Kiwi Schoencreme Zwart blikje 50ml", "product_desc": null, "product_full_image": null, "product_sku": "20380325", "product_sku_factory": "56658972", "barcode": "5000204657913", "product_in_stock": "1", "category_id": "7", "specificaties": [ { "Name": "Artikel nummer", "Value": "20380325" }, { "Name": "Artikelnummer fabrikant", "Value": "56658972" } ], "prices": [ "1.79000000000000", null, "3.50000000000000", "1.2100", "0" ], "brand": { "category_name": "Diversen", "category_full_image": "helms.jpg", "category_url": "diversen", "no-photo": "no-picture-2.png", "brand_id": "35", "link": "\/merken\/diversen\/", "name": "Diversen", "image": "\/media\/vendor\/helms.jpg" } }, {...}, ...]
----
Toelichting:
--
Opvragen product informatie. Dit is de meest uitgebreide vorm. Producten bevatten minimaal de volgende informatie:
{ "product_name": "Kiwi Schoencreme Zwart blikje 50ml", "product_desc": null, "product_sku": "20380325"}
Shop beheerders hebben de mogelijkheid om toestemming aan de klant te geven zodat deze meer gegevens op kan vragen.
----------------------------------------
Request:
--
POST /api/categorie/get/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71Content-Type: application/x-www-form-urlencodedContent-Length: 150api_key=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A&api_secret=MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCirfGZAfwYr/RN&api_user=jaap@mijntestpartner.nl----Response:--HTTP/1.1 200 OKContent-Type: text/json;charset=UTF-8Content-Length: 28719[ { "category_id": "1", "category_name": "Huishoud", "category_description": "Huishoud", "category_full_image": "nr.3.jpg", "subcategories": [ { "category_id": "14", "category_name": "Aanstekers", "category_description": "Aanstekers", "category_full_image": "4895151826267.jpg" }, { ... }, ... ] }, {...}, ...]
----
Toelichting:
--
Opvragen categorie informatie. Dit is de meest uitgebreide vorm. Categorieën bevatten minimaal de volgende informatie:
{ "category_id": "1", "category_name": "Huishoud", "category_description": "Huishoud"}
Shop beheerders hebben de mogelijkheid om toestemming te geven aan de klant om categorieinformatie op te vragen. De beheerder kan hierbij ook aangeven welke gegevens de klant extra mag op vragen.
----------------------------------------
Request:
--
POST /api/brand/get/ HTTP/1.1Host: bootstrap.mijnwebshoppartnerCookie: PHPSESSID=ljrqf1r7m0lrkr5qul9ekg7t71Content-Type: application/x-www-form-urlencodedContent-Length: 150api_key=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A&api_secret=MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCirfGZAfwYr/RN&api_user=jaap@mijntestpartner.nl----Response:--HTTP/1.1 200 OKContent-Type: text/json;charset=UTF-8Content-Length: 7248[ { "category_full_image": "allibert.jpg", "brand_id": "1", "name": "Allibert" }, { ... }, ...]
----
Toelichting:
--
Opvragen merk informatie. Dit is de meest uitgebreide vorm. Merken bevatten minimaal de volgende informatie:
{ "brand_id": "1", "name": "Allibert"}
Shop beheerders hebben de mogelijkheid om toestemming te geven aan de klant om merkinformatie op te vragen. De beheerder kan hierbij ook aangeven welke gegevens de klant extra mag op vragen.
