apeman-api-verify
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 = let NODE_ENV = processenv moduleexports = $cwd: __dirname $pkg: /* ... */ $proto: /* ... */ $api: // Define APIs 'module01': logging: NODE_ENV === 'development'
Then, call the module from client script
#!/usr/bin/env node /** * Example client */'use strict' const co = const apemanApiClient =
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 |
---|---|---|
string |
.needsVerify(email)
Check if verify needed
Param | Type | Description |
---|---|---|
|
.verify(token)
Verify email value
Param | Type | Description |
---|---|---|
token | string |
License
This software is released under the MIT License.