Skip to content

Latest commit

 

History

History
137 lines (107 loc) · 4 KB

README.md

File metadata and controls

137 lines (107 loc) · 4 KB
Raw

quickbase

npm license npm version npm downloads

A lightweight, typed, promise-based Quickbase API, autogenerated from the OpenAPI spec

Written in TypeScript, targets Nodejs and the Browser.

A large chunk of this library is generated based on the OpenAPI definition found at https://developer.quickbase.com/.

All the types and public methods are generated and kept updated directly from the OpenAPI definition.

You can find this code in src/code-generation/.

This library targets the RESTful, JSON-based API, not the XML-based API. If you want to use the XML-based API, then please use v2.x of this library.

IE 11 Users, if you are receiving this error:
XMLHttpRequest: Network Error 0x80070005, Access is denied.

This is not a limitation of the library, just how Quickbase's new API works.
In order to use the new RESTful JSON-based API in Internet Explorer, you must
change a security setting:

- Go to Internet Options -> Security -> Custom Level
- Scroll down to and find the "Miscellaneous" section
- Ensure "Access data sources across domains" is set to "Enable"
- Click "OK", "Yes", "OK"

Install

# Install
$ npm install --save quickbase

Documentation

TypeDoc Documentation Quickbase Documentation

Server-Side Example

import { QuickBase } from 'quickbase';

const quickbase = new QuickBase({
    realm: 'www',
    userToken: 'xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxxxxx'
    // Use tempToken if utilizing an authentication token sent
    // up from client-side code. If possible, this is preferred.
    // tempToken: 'xxxxxx_xxx_xxxxxxxxxxxxxxxxxxxxxxxxxx',
    // appToken: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
});

(async () => {
    try {
        const results = await quickbase.getApp({
            appId: 'xxxxxxxxx'
        });

        console.log(results.name);
    }catch(err){
        console.error(err);
    }
})();

Client-Side Example

Import QuickBase by loading quickbase.browserify.min.js

var quickbase = new QuickBase({
    realm: 'www',
    appToken: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
});

// Using a Temporary Token
quickbase.getTempTokenDBID({
    dbid: 'xxxxxxxxx'
}).then(function(results){
    return quickbase.getApp({
        appId: 'xxxxxxxxx'
    });
}).then(function(results){
    console.log(results.name);
}).catch(function(err){
    console.error(err);
});

Debugging

Server-side, set the environment variable DEBUG to quickbase:*.

In the browser, open the dev console and enter: window.localStorage.debug = 'quickbase:*'.

The used debug namespaces: main, request, response and for development: build and generate.

Development

# Fork and clone the repository
$ yarn install
$ git checkout -b feature/branch
# Download the latest OAS definition and replace in `assets/QuickBase_RESTful_API.json`
$ yarn run generate
# Manually modify as required
$ yarn run build
$ yarn run test
$ yarn run docs
$ git add
$ git commit
$ git push -u origin feature/branch

License

Copyright 2014 Tristian Flanagan

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.