Notice: You are browsing the documentation for PrestaShop 9, which is currently in development.
You might want to read the documentation for the current version, PrestaShop 8. Read the current version of this page
Now that your access key is generated you can test your store’s webservice, its endpoint is located in the /api/ uri at the root of your installation of Prestashop.
The quickest way to test your API is to use your browser:
The shop should prompt you for a username and a password to enter. The username is the authentication key you created and there is no password to enter. If no permission has been set for the key, then the browser will keep asking you to enter the key indefinitely.
The second way to access the API is to include your access key in the url, this will prevent you from entering any user name. Here is an example, assuming your access API key is UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX:
The best way to authenticate your API calls is to use an Authorization header, this way you don’t expose your API key directly but a base64_encode compute of your user:password couple. Although PrestaShop API only has a user with empty password, so in order to compute your authorization key you can do as follows:
<?php
$apiKey = `UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX`;
$authorizationKey = base64_encode($apiKey . ':'); // VUNDTExROU4yQVJTSFdDWExUNzRLVUtTU0szNEJGS1g6
Then you can use this value in your request header:
| Key | Value |
|---|---|
Authorization |
Basic VUNDTExROU4yQVJTSFdDWExUNzRLVUtTU0szNEJGS1g6 |
To test/call your APIs we recommend you use an API client such as Insomnia or Postman, it is easier to call the APIs than with a browser, you can easily switch with HTTP methods, and it’s easier to set request parameters and headers.
If you have trouble authenticating to the Webservice, please read the following information:
The webserver may need the CGIPassAuth directive enabled to allow PrestaShop to receive the HTTP_AUTHORIZATION header.
You can enable it in your .htaccess:
CGIPassAuth On
Or, also in .htaccess, use SetEnv:
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
The /api/ URL gives you the root of all the resources, in the form of an XML file. Here is an example of what you should see if you authorized full access to addresses, images and products resources:
<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
<api shopName="Prestashop">
<addresses xlink:href="http://example.com/api/addresses" get="true" put="true" post="true" patch="true" delete="true" head="true">
<description xlink:href="http://example.com/api/addresses" get="true" put="true" post="true" patch="true" delete="true" head="true">
The Customer, Brand and Customer addresses</description>
<schema xlink:href="http://example.com/api/addresses?schema=blank" type="blank"/>
<schema xlink:href="http://example.com/api/addresses?schema=synopsis" type="synopsis"/>
</addresses>
<images xlink:href="http://example.com/api/images" get="true" put="true" post="true" patch="true" delete="true" head="true">
<description xlink:href="http://example.com/api/images" get="true" put="true" post="true" patch="true" delete="true" head="true">
The images</description>
</images>
<products xlink:href="http://example.com/api/products" get="true" put="true" post="true" patch="true" delete="true" head="true">
<description xlink:href="http://example.com/api/products" get="true" put="true" patch="true" post="true" delete="true" head="true">
The products</description>
<schema xlink:href="http://example.com/api/products?schema=blank" type="blank"/>
<schema xlink:href="http://example.com/api/products?schema=synopsis" type="synopsis"/>
</products>
</api>
</prestashop>
You can also see that each resource provides two links to access its schemas:
Let’s see what they look like for the address resource.
/api/addresses?schema=blank
<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
<address>
<id></id>
<id_customer></id_customer>
<id_manufacturer></id_manufacturer>
<id_supplier></id_supplier>
<id_warehouse></id_warehouse>
<id_country></id_country>
<id_state></id_state>
<alias></alias>
<company></company>
<lastname></lastname>
<firstname></firstname>
<vat_number></vat_number>
<address1></address1>
<address2></address2>
<postcode></postcode>
<city></city>
<other></other>
<phone></phone>
<phone_mobile></phone_mobile>
<dni></dni>
<deleted></deleted>
<date_add></date_add>
<date_upd></date_upd>
</address>
</prestashop>
/api/addresses?schema=synopsis
<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
<address>
<id_customer format="isNullOrUnsignedId"></id_customer>
<id_manufacturer format="isNullOrUnsignedId"></id_manufacturer>
<id_supplier format="isNullOrUnsignedId"></id_supplier>
<id_warehouse format="isNullOrUnsignedId"></id_warehouse>
<id_country required="true" format="isUnsignedId"></id_country>
<id_state format="isNullOrUnsignedId"></id_state>
<alias required="true" maxSize="32" format="isGenericName"></alias>
<company maxSize="255" format="isGenericName"></company>
<lastname required="true" maxSize="255" format="isName"></lastname>
<firstname required="true" maxSize="255" format="isName"></firstname>
<vat_number format="isGenericName"></vat_number>
<address1 required="true" maxSize="128" format="isAddress"></address1>
<address2 maxSize="128" format="isAddress"></address2>
<postcode maxSize="12" format="isPostCode"></postcode>
<city required="true" maxSize="64" format="isCityName"></city>
<other maxSize="300" format="isMessage"></other>
<phone maxSize="32" format="isPhoneNumber"></phone>
<phone_mobile maxSize="32" format="isPhoneNumber"></phone_mobile>
<dni maxSize="16" format="isDniLite"></dni>
<deleted format="isBool"></deleted>
<date_add format="isDate"></date_add>
<date_upd format="isDate"></date_upd>
</address>
</prestashop>