Giter Club home page Giter Club logo

node-agilite's Introduction

agilite

A NodeJS module that provides seamless interactions with Agilit-e APIs.

Created by Agilit-e

Installation

Using npm:

npm install agilite

In Node.js:

const Agilite = require('agilite');

const agilite = new Agilite({
    apiServerUrl: "{api_server_url}",
    apiKey: "{agilite_api_key}"
});

agilite.Keywords.getData()
.then((response) => {
    console.log(response.data);
})
.catch((err) => {
    console.log(err.response.data);
})

To Run Unit Tests

npm run test

APIs

Every API returns a promise

Each of App APIs except the Utility APIs contain a postData, getData, putData and deleteData function that can be used for CRUD requests. e.g

postData

  • data - The request body data to post
agilite.Keywords.postData(data)

getData

  • profileKeys - Array of Profile Keys to return
  • recordIds - Array of Record Ids to return
  • slimResult - Default: true, Only return data
agilite.Keywords.getData(profileKeys, recordIds, slimResult)

putData

  • recordId - The Id of the record to PUT / Update
  • data - The request body data to put
agilite.Keywords.putData(recordId, data)

deleteData

  • recordId - The Id of the record to DELETE / Remove
agilite.Keywords.deleteData(recordId)

executeCRUDRequest - Executes a CRUD request relative to any Agilit-e App

  • appName - The App Name relative to the Request. e.g. "keywords" or "numbering"
  • reqType - The Request Type. e.g. "GET", "PUT"
  • data - Optional request body data
  • headers - Request Headers
agilite.executeCRUDRequest(appName, reqType, data, headers)

App APIs

node-agilite's People

Contributors

arrieagilite avatar johann-agilite avatar agilitehub avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.