sitefinity-webservices-sdk v1.0.0

DEPRECATED

Sitefinity WebServices SDK package is deprecated and a new package under the Progress domain is created (Link). The old package will not be removed from npm for compatibility. This repository would be no longer maintained.

Sitefinity WebServices SDK

Introduction

The Sitefinity WebServices JavaScript SDK is intended to help clients use the sitefinity OData web services by providing easy way to build requests and recieve response data.

Development

1. Run $ npm install in the root of the project.

The source code is available in the src folder.

To build the source code use:

$ npm run build:dev

To build and serve the source code on each change:

$ npm start

The output is located in the dist folder of the project - sitefinity-webservices-sdk.js

Other commands

To build minified source code:

$ npm run build:prod

To prepare realese code (bulds minified source, creates documentation):

$ npm run build:release

The release output is located in the dist folder of the project. It contains the source and documentation.

Documentation

To generate the SDK documentation $ npm run build:release command must be executed. Docs can be found inside the dist/documentation folder.

Samples

There are examples how to use the SDK and create various types of request. The file is located in the dist folder - samples.html To run it, you need to build the source code of the SDK. Then replace my_sandbox_location with the server location you are using.

var options = {
    serviceUrl: "my_sandbox_location" + "/api/default/"
}

Also replace username and password with the credentials of your user.

sf.authentication.login("username", "password");

License

This project is licensed under the terms of the MIT license.