Query String Builder API

Query String Builder converts JSON objects into properly formatted URL query strings with optional encoding.

This is a Javascript Wrapper for the Query String Builder API

Installation

Using npm:

npm install @apiverve/querystringbuilder

Using yarn:

yarn add @apiverve/querystringbuilder

Configuration

Before using the Query String Builder API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com

Quick Start

Get started with the Quick Start Guide

The Query String Builder API documentation is found here: https://docs.apiverve.com/ref/querystringbuilder. You can find parameters, example responses, and status codes documented here.

Setup

const querystringbuilderAPI = require('@apiverve/querystringbuilder');
const api = new querystringbuilderAPI({
    api_key: '[YOUR_API_KEY]'
});

Usage

Perform Request

Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.

var query = {
  "params": {
    "name": "John Doe",
    "age": 30,
    "city": "New York",
    "interests": [
      "coding",
      "music",
      "travel"
    ]
  },
  "encode": true
};

api.execute(query, function (error, data) {
    if (error) {
        return console.error(error);
    } else {
        console.log(data);
    }
});

Using Promises

You can also use promises to make requests. The API returns a promise that you can use to handle the response.

var query = {
  "params": {
    "name": "John Doe",
    "age": 30,
    "city": "New York",
    "interests": [
      "coding",
      "music",
      "travel"
    ]
  },
  "encode": true
};

api.execute(query)
    .then(data => {
        console.log(data);
    })
    .catch(error => {
        console.error(error);
    });

Using Async/Await

You can also use async/await to make requests. The API returns a promise that you can use to handle the response.

async function makeRequest() {
    var query = {
  "params": {
    "name": "John Doe",
    "age": 30,
    "city": "New York",
    "interests": [
      "coding",
      "music",
      "travel"
    ]
  },
  "encode": true
};

    try {
        const data = await api.execute(query);
        console.log(data);
    } catch (error) {
        console.error(error);
    }
}

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "queryString": "name=John%20Doe&age=30&city=New%20York&interests=coding&interests=music&interests=travel",
    "fullURL": "?name=John%20Doe&age=30&city=New%20York&interests=coding&interests=music&interests=travel",
    "encoded": true,
    "paramCount": 4
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.

Updates

Stay up to date by following @apiverveHQ on Twitter.

Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.

License

Licensed under the The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package detail

@apiverve/querystringbuilder

readme