Giter VIP home page Giter VIP logo

soracom_api's Introduction

About soracom_api

install

npm install soracom_api

how to use

"authKey" and "token" are checked automatically in this API.

authorization

The API supports the both of authorization methods: email/password and authKey and secret.

var soracom = new Soracom({email: 'mail address',password:'password'});
var soracom = new Soracom({authKeyId: 'keyId',authKey:'secret'});

When this API accesses SORACOM service, it takes authKey and token automatically.

get information of SIM

var Soracom = require('soracom_api');
var soracom = new Soracom({email: 'mail address',password:'password'});
soracom.get('/subscribers',function(err,res){
  console.log({err:err,res:res});
});

set name into SIM

var Soracom = require('soracom_api');
var soracom = new Soracom({authKeyId: 'keyId',authKey:'secret'});
soracom.put('/subscribers/imsi/tags',[
  {
    "tagName": "name",
    "tagValue": "my_test_sim"
  }
],function(err,res){
  console.log({err:err,res:res});
});

API

soracom.get('path',function(err,res){ callback });

parameters:

  • path: request path return:
  • err: error message
  • res: response

soracom.post('path',params,function(err,res){ callback });

  • parameters:
  • path: request path
  • params: request body. it can be omitted.
  • return:
  • err: error message
  • res: response

soracom.put('path',params,function(err,res){ callback });

  • parameters:

  • path: request path

  • params: request body. it can be omitted.

  • return:

  • err: error message

  • res: response

soracom.delete('path',params,function(err,res){ callback });

  • parameters:
  • path: request path
  • params: request body. it can be omitted.
  • return:
  • err: error message
  • res: response

soracom_api's People

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.