@ads-attack/qicko-api-connect

Node module for qicko api connections

Usage no npm install needed!

<script type="module">
  import adsAttackQickoApiConnect from 'https://cdn.skypack.dev/@ads-attack/qicko-api-connect';
</script>

README

Qicko API Connect

A node library for fetching and inserting data on the qicko-api.

Dependencies

  • axios
  • qs

Usage

Installation

$ npm install --save qicko-api-connect

Setup

import { api } from 'qicko-api-connect'

let qickoAPI = api.create({
  clientId: <qicko-api-client-id>,
  accessToken: <qicko-api-access-token>,
  env: <node environment>,
  baseURL: <your-custom-api-url>
})
Property Description Default Value
clientId The provided client id given by the api administrator. *required (Should not be blank)
accessToken API access token provided by api upon login. (blank string)
env The current api environment your are getting date from. Accepted values: development, staging, and production.
Corresponding API urls:

- development: 'http://localhost:8000/api/v2.0/'
- staging: 'https://qicko-api-staging.herokuapp.com/api/v2.0/'
- production: 'https://qicko-api.herokuapp.com/api/v2.0/'		 development
baseURL In case, a custom api url is required. This overrides the url provided by env. undefined

Api

[under construction] getObject()

getObjects()

saveObject()

archiveObject()

deleteObject()

Todos

Add facebook login, etc