apeman-api-verify

Verify API for Apeman

Usage no npm install needed!

<script type="module">
  import apemanApiVerify from 'https://cdn.skypack.dev/apeman-api-verify';
</script>

README

apeman-api-verify

Build Status Code Climate Code Coverage npm Version JS Standard

Verify API for Apeman

Installation

$ npm install apeman-api-verify --save

Usage

Define a module in Apemanfile and run the server.

/** Example of Apemanfile.js */

'use strict'

const co = require('co')

let { NODE_ENV } = process.env

module.exports = {
  $cwd: __dirname,
  $pkg: { /* ... */ },
  $proto: [ /* ... */ ],
  $api: {
    // Define APIs
    'module01': require('apeman-api-verify')({
      logging: NODE_ENV === 'development'
    })
  }
}

Then, call the module from client script

#!/usr/bin/env node

/**
 * Example client
 */
'use strict'

const co = require('co')
const apemanApiClient = require('apeman-api-client')

co(function * () {
  // Setup an client
  let api = yield apemanApiClient('/api')

  // Connect to a module
  let module01 = yield api.connect('module01')
  let pong = yield module01.ping()
  /* ... */
})


Methods

The following methods are provided by the API.

.ping(pong)

Test the reachability of the api.

Param Type Description
pong string Pong message to return

.issue(email)

Issue verify email

Param Type Description
email string

.needsVerify(email)

Check if verify needed

Param Type Description
email

.verify(token)

Verify email value

Param Type Description
token string

License

This software is released under the MIT License.

Links