Socket
Socket
Sign inDemoInstall

apiners

Package Overview
Dependencies
0
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    apiners

a Node JS API for Sending SMS, Geocoding and Reverse Geocoding.


Version published
Maintainers
1
Created

Readme

Source

Apiners

Node JS API for SMS, Directions, Geocoding and Reverse Geocoding Powerd by Apiners.com.

  This API is only in TEST VERSION. Public Version will come soon.

Installation

You can use this package on the server side.

Node.js:

npm install apiners

Sending SMS


var apiners = require("apiners")

apiners.sendSMS({
    username: "MyUsername",
    key: "MyKey",
    phone: "07XXXXXXX",
    message: "Hi there"
}, function(_data){
     console.log(_data)
})

  • username -- String
  • key -- String
  • phone -- String
  • message -- String

Direction


var apiners = require("apiners")

apiners.Direction({
    username: "MyUsername",
    key: "MyKey",
    lat1: 42.0000,
    lon1: 22.0000,
    lat2: 42.1234,
    lon2: 22.1234,
}, function(_data){
     console.log(_data)
})

  • username -- String
  • key -- String
  • lat1, lon1 -- Decimal (Start Direction Point)
  • lat2, lon2 -- Decimal (End Direction Point)

Geocode


var apiners = require("apiners")

apiners.Geocode({
    username: "MyUsername",
    key: "MyKey",
    Address: "Street Avene 54"
}, function(_data){
     console.log(_data)
})

  • username -- String
  • key -- String
  • address, String (Lookup Address)

Reverse Geocode


var apiners = require("apiners")

apiners.ReverseGeocode({
  username: "MyUsername",
  key: "MyKey",
  Lat: 42.000,
  Lon: 22.000,

}, function(_data){
   console.log(_data)
})

  • username -- String
  • key -- String
  • lat -- Decimal
  • lon -- Decimal

Returning Errors

  • Hx000 = {OK}
  • Hx001 = {Invalid URL}
  • Hx002 = {Invalid Type}
  • Hx003 = {Invalid Type URL}
  • Hx004 = {Invalid Key}
  • Hx005 = {Invalid Request}
  • Hx006 = {Limit Еxceed}
  • Hx007 = {Invalid Username}
  • Hx101 = {Invalid SMS Parameters}
  • Hx102 = {SMS Day Limit Еxceed}
  • Hx103 = {SMS Invalid phone number}
  • Hx301 = {Invalid Geocode Arguments}
  • Hx302 = {Geocode Limit Еxceed}
  • Hx401 = {Invalid Reverse Geocode Arguments}
  • Hx402 = {Reverse Geocode Limit Еxceed}
  • Hx501 = {Invalid Direction Arguments}
  • Hx502 = {Direction Day Limit Еxceed}
  • Hx201 = {Invalid GeoCode Parameters}
  • Hx301 = {Invalid ReverseGeoCode Parameters}
  • Hx099 = {Coming Soon}

Credits

This package is based on the work of Tafoma Dev Team. More information You can find on http://www.apiners.com

License

Copyright © 2017, APINERS

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
  list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.
* Neither the name Crypto-JS nor the names of its contributors may be used to
  endorse or promote products derived from this software without specific prior
  written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FAQs

Last updated on 09 Mar 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc