Skip to main content

Getting Started

You can connect to the WizCloud database and begin importing and exporting data in a few simple steps.

Here's all you need to do, with an example of importing an invoice into the WizCloud database:

Step 1 - Get Identifying Details

Retrieve your identifying WizCloud details, you’re going to need a token, the database code and the server name.
Click here to see where you can find them.

Example
  • WizcloudApiServer: lb1.wizcloud.co.il
  • WizcloudApiPrivateKey (token): xj9ubkpxabq97ym4e45i7vtnc7h8jgy8c1cxzypa
  • WizcloudApiDBName: wizdb12n12

Step 2 - Send a GET createSession request

Next you need to issue your wizAuthToken.
To do so, send a GET createSession request that includes the above mentioned details. This request should only be sent once before any other API requests to WizCloud.

Full path structure: https://{WizcloudApiServer}/createSession/{WizcloudApiPrivateKey}/{WizcloudApiDBName}

Example

createSession request

After clicking on send you'll get your unique wizAuthToken (expires after 24 hours).

Step 3 - Send a POST Request

That's all the set up, now you can start importing or exporting your data of choice.

Each request you send to the WizCloud database must include the following 3 parts:

1. apiPath (Header)

See the full list of api paths here.

Full path strcture: https://{WizcloudApiServer}/{apiPath}

Example

https://lb1.wizcloud.co.il/invApi/createDoc apiPath

2. wizAuthToken (Header)

Your wizAuthToken (from step 2) in the Authorization parameter in the request's Header

Example

createSession request

3. JSON (Body)

Lastly, send the JSON with the parameters you wish to update in the Body of the request:

Example
{
"issueStock": "true",
"deleteTemp": "false",
"rows": {
"StockID": 0,
"DocumentID": 1,
"AccountKey": "30000",
"moves": [
{
"ItemKey": "1001",
"Quantity": 20,
"Price":10.5
},
{
"ItemKey": "1002",
"Quantity": 5,
"Price":100
}
]
}
}