Connector API enables developers to access Wix REST API without setting up apps or OAuth.
Base URL for all requests:
https://certifiedcode.editorx.io/connector/_functions
Send request via Proxy
POST /proxy
For HTTP actions, Connector API acts as a proxy, so you only need to supply the API key to gain access to the endpoint.
Code Example
Node JS:
var axios = require('axios');
var data = JSON.stringify({
"method": "get", // http method
"url": "https://www.wixapis.com/site-properties/v4/properties" // endpoint url
"data": "{}" // data (body) after JSON stringify. note: method like GET does not need to pass "data" field.
});
var config = {
method: 'post', // always POST
url: 'https://certifiedcode.editorx.io/connector/_functions/proxy', // always this proxy url
headers: {
'x-connector-api-key': 'API_KEY', // replace with your own API key
'Content-Type': 'application/json'
},
data : data // request config in axios format
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});cURL:
curl --location --request POST 'https://certifiedcode.editorx.io/connector/_functions/proxy' \
--header 'x-connector-api-key: apiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
"method": "get",
"url": "https://www.wixapis.com/site-properties/v4/properties"
}'
Create Webhook
POST /hook/subscribe
For Webhook events sent from Wix, Connector API acts as a distributor to send (POST) the received events to all of your configured endpoints.
Code Example
cURL:
curl --location --request POST 'https://certifiedcode.editorx.io/connector/_functions/hook/subscribe' \
--header 'x-connector-api-key: apiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
"eventType": "com.wix.ecom.new_order", // demo event type, for actual event type string, please see the Wix REST API Docs.
"url": "https://www.wixsite.com/_functions/new_order" // endpoint to receive events
}'
Delete Webhook
DELETE /hook/unsubscribe
You can delete the webhook created via API. If you lost the hook ID, you could contact Connector support to delete the webhook. Currently, we do not have an interface to manage webhook.
Code Example
cURL:
curl --location --request DELETE 'https://certifiedcode.editorx.io/connector/_functions/hook/unsubscribe?hookId=UUID' \ // id received when creating a webhook
--header 'x-connector-api-key: apiKey' \
--header 'Content-Type: application/json' \'
How does Connector count your usage?
Each API call/webhook event sent counts as one usage.
For example, you sent a request via Proxy, and then one credit was consumed.
For example, you received a webhook event and consumed one credit. You can set up multiple webhook endpoints, in which each counts one credit.
You can view your usage on Wix Site Dashboard (Business Manager) > Connector > Usage.