@xmlformio/api v1.0.7

xmlform_io_rest_api

@xmlformio/api - JavaScript client for xmlform_io_rest_api Xmlform.io REST API for working with web forms backed by XML data This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://xmlform.io/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install xmlform_io_rest_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your xmlform_io_rest_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @xmlformio/api = require('xmlform_io_rest_api');

var defaultClient = @xmlformio/api.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new @xmlformio/api.XmlformioApi()
var body = {key: null}; // {Object} form data submitted from xmlform.io web form
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.formToXml(body, callback);

Documentation for API Endpoints

All URIs are relative to https://api.xmlform.io

Documentation for Models

• @xmlformio/api.JwtLogin200Response
• @xmlformio/api.Project
• @xmlformio/api.ProjectForms

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

basicAuth

• Type: HTTP basic authentication