one_time_password_sms_v1 v0.5.0

one_time_password_sms

OneTimePasswordSms - JavaScript client for one_time_password_sms Service Enabling Network Function API to send short-lived OTPs (one time passwords) to a phone number via SMS and validate it afterwards, in order to verify the phone number as a proof of possession. # Relevant Definitions and concepts - NaaS: Network-as-a-Service model where Telco Network resources are exposed to third parties through APIs. In this particular API, One Time Password is exposed following this model. - OTP: One Time password is a one-time authorization code (OTAC) that is valid for only one login session or transaction. # API Functionality It enables a Service Provider (SP) to send an OTP code by SMS and validate it to verify the phone number (MSISDN) as a proof of possession. # Resources and Operations overview This API currently provides two endpoints, one to send an OTP to a given phone number and another to validate the code received as input. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.5.0
• Package version: 0.5.0
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit http://www.example.com/support

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install one_time_password_sms --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var OneTimePasswordSms = require('one_time_password_sms');
var defaultClient = OneTimePasswordSms.ApiClient.instance;

// Configure OAuth2 access token for authorization: two_legged
var two_legged = defaultClient.authentications['two_legged'];
two_legged.accessToken = "YOUR ACCESS TOKEN"

var api = new OneTimePasswordSms.OTPManagementApi()
var body = new OneTimePasswordSms.SendCodeBody(); // {SendCodeBody} 
var opts = { 
  'xCorrelator': "xCorrelator_example" // {String} Correlation id for the different services
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendCode(body, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://{host}{basePath}

Documentation for Models

• OneTimePasswordSms.AuthenticationId
• OneTimePasswordSms.Code
• OneTimePasswordSms.ErrorInfo
• OneTimePasswordSms.Message
• OneTimePasswordSms.PhoneNumber
• OneTimePasswordSms.SendCodeBody
• OneTimePasswordSms.SendCodeResponse
• OneTimePasswordSms.ValidateCodeBody

Documentation for Authorization

two_legged

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • :