Class: APIBuilder

APIBuilder

new APIBuilder()

Builder used to create new instances of the Wix object

Source:
  • WixClient.js

Methods

withCredentials(data) → {Wix}

Creates a Wix API object with the give credentials.

Parameters:
Name Type Description
data APIBuilder.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
Properties:
Name Type Argument Description
secretKey String

Your applications Secret Key

appId string

Your applications App Id

instanceId String <nullable>

Your applications instanceId

instance String <nullable>

The instance passed to your server from Wix

Source:
  • WixClient.js