The App API allows you to control a kvik.shop shop from the administration point of view. The API is valuable when you want to connect your ERP with your shop or to develop your own automations around your shop. The App API is a set of HTTP endpoints organized around REST.
The App API allows reading and manipulation of orders. You can connect your ERP to this API, read new orders via the API and send changes to orders back from the ERP to the e-shop. The API can also be used to retrieve the current product price for a given user.
You can use the App API in combination with the XML2DB API (XML2DB). Through XML2DB you can retrieve new orders and their changes from the shop to the ERP and then send the changes from the ERP back to the shop through the App API.
Activation
The App API is available as an additional shop module. You can request activation in the shop Admin, in Settings → Modules and Services. We will then activate the module and send you credentials.
URL Structure
API for your shop runs at the same domain as your shop and uses /api/app URL path prefix.
Example
yourshopname.com/api/app…
HTTPS Only
App API requires to communiacate over secured HTTPS protocol. There is no traffic redirection from HTTP to HTTPS. The API responds with 403 Forbidden error code when requested on HTTP protocol.
Compressed Responses Only
- The API will send compressed responses only.
- Compression algorithm can be chosen by the client.
- Supported algorithm is Gzip
- All API requests have to contain the
Accept-Encodingheader withgzipvalue. - The API will respond with
400 Bad Requestresponse code if such the request will not be called with such Accept-Encoding value.
Accept-Encoding: gzip
Content type
- The API requires
Content-Typeheader to be included in the requests with body - Typically, it is required for
POSTandPATCHrequest with body containing JSON
Content-Type: application/json
Feature Requests
If you need additional possibilities in the API, please write us your requests at [email protected].
