new APIBuilder()
Builder used to create new instances of the Wix object
- Source:
- WixClient.js
Methods
-
withCredentials(data) → {Wix}
-
Creates a
WixAPI object with the give credentials.Parameters:
Name Type Description dataAPIBuilder.APICredentials JSON data containing credentials for the API
- Source:
- WixClient.js
Throws:
-
an exception if signatures don't match when using the API with the instance param
-
an exception if API credentials are missing
Returns:
a Wix API interface object
- Type
- Wix
Type Definitions
-
APICredentials
-
Credentials to access the Wix API. Must specific either an instance or an instanceId property
Type:
- Object
- Source:
- WixClient.js
Properties:
Name Type Argument Description secretKeyString Your applications Secret Key
appIdstring Your applications App Id
instanceIdString <nullable>
Your applications instanceId
instanceString <nullable>
The instance passed to your server from Wix