Javascript SDK

Github | npm

Det enklaste och rekommenderade (läs: smartaste) sättet att använda nomado REST API i din Node.js-applikation är via vårt SDK.


Installation

npm install nomado

Snabbstart

Om ni inte redan har ett nomado-konto, registrera er och få 10€ till ert konto.

Nedan följer ett snabbt exempel för hur ni startar biblioteket och skickar ett sms.

const nomadoClient = require('nomado');

const USERNAME = 'username';
const PASSWORD = 'password';

const nomado = new nomadoClient({USERNAME, PASSWORD});

const smsOptions = {
  to: ['32456789012'],
  message: 'Hello world',
  unicode: false
};

nomado.sms.send(smsOptions)
    .then((response) => {
      console.log(response.code);
      console.log(response.data);
    })
    .catch((error) => {
      console.log(error.code);
      console.log(error.reason);
    });

Svar

Varje call kommer att returnera ett löfte som kommer att bli löst (eller avvisat) med ett nomadoResponse object som omsluter API-svarskoden och datan.

// Result object:
{
  code: 200, //OK!
  reason: "", //in case of error
  data: {}
}

Autentisering

Öppna först biblioteket med era nomado-användaruppgifter.

const nomado = new nomadoClient({USERNAME, PASSWORD});

Nu kan du börja skicka begäran till API.

Funktioner

nomadoClient class tillhandahåller de offentliga gränssnitten för åtkomst till nomado API.

  • SMS
  • OTP
  • HLR
  • Calls
  • Account

SMS

sms.send()

Skicka ett sms till ett eller flera nummer.

nomado.sms.send({
  to: ['3245678901','3245678902'], // e164 formatted numberr in array
  message: 'My first sms from nomado!', 
  unicode: false // Boolean: unicode.
});

OTP

otp.send()

Att generera OTP-kod och skicka via sms till era användare är så enkelt som nedan:

nomado.otp.send({
      "to": "32412345678",
      "template": "Your verification code is {{CODE}}",
      "type": "NUMERIC",
      "length": 4,
      "expiry": 7200
})

otp.verify()
nomado.otp.verify({
  number: '32456789012', // E164 formatted mobile number used,
  token: '456789' // OTP generated in previous call. You do not need to store it locally.
})

HLR

hlr.fetch()

Gör en förfrågan

nomado.hlr.fetch({
  numbers: ['32456789012','32456789013'], // e164 formatted numbers
});

hlr.validate()
nomado.hlr.validate({
  number: '32456789012', // e164 formatted number
});