Giter VIP home page Giter VIP logo

rtx-platform-node's Introduction

RTX Platform API support

This is beta version

Installation

npm install rtx-platform --save

Usage

Initializing client

The constructor takes the following parameters:

  • @param {string} baseUrl - (Required) base API URL, Ex. 'https://api.rtxplatform.com'.
  • @param {string} apiKey - (Required) RTX apiKey.
  • @param {string} secretKey - (Required) RTX secretKey.

You can find auth info on: https://app.rtxplatform.com/account/developer-api

const RTXClient = require('rtx-platform');


let rtxClient = new RTXClient('https://api.rtxplatform.com/', '<your api_key>', 'your secret_key');

Making request

rtxClient.request function is used to make API calls, it returns promise if no callBack function is passed, and takes the following paramaters:

  • @param {string} method - (Required) HTTP method Ex. <'GET' | 'POST' | 'PUT' | 'UPDATE'>.
  • @param {string} resourcePath - (Required) Ex. '/pops-api/v1/creatives'.
  • @param {object} queryParams - (Optional) Additional URL query parameters.
  • @param {object/string} body - (Optional) Request body payload.
  • @param {function} callBack - (Optional) Call back function that takes 3 parameters (err, response, body), will return promise if this parameter was ignored.

Examples

Get all pops creatives

rtxClient.request('GET', '/pops-api/v1/creatives', null, null).then(res => {
  console.log(JSON.stringify(res))
});

Get paused pops creatives

rtxClient.request('GET', '/pops-api/v1/creatives', {status: 'paused'}, null).then(res => {
  console.log(JSON.stringify(res))
});

Using callback instead of promises

rtxClient.request('GET', '/pops-api/v1/creatives', {status: 'paused'}, null, function(err, res, body){
  console.log(JSON.stringify(body));
});

rtx-platform-node's People

Contributors

a114m avatar

Watchers

Ian De Croix 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.