Assumptions
This guide assumes proficiency in web application development using Typescript and Node.js
Stack: TypeScript and Node.js. See package.json for more information
This server is intended to handle various use-case projects within the authenticate-ui-sdk workspace.
Please review the installation instructions withing the README.md file of the authenticate-node-server directory.
Before you start
Please review the following articles before continuing:
You will need to have signed up your organisation in Haventec Console 2.0.
Further, you will need to have created an application which you would like to authenticate with Haventec.
Configuration
The server refers to the config.js file at the root of this directory for values, as set out below:
Signature | Description |
config.application.apiKey
|
This represents the Application API Key provisioned for your application. You can find more detail on how to find your application's api key here.
|
config.application.haventecServer: string
|
The Haventec Authenticate Server domain.
The default value of 'https://api-demo.haventec.com' points to the secure domain hosting Haventec's Authenticate SaaS. |
config.server.host
|
The host domain used to provide or proxy Haventec Authenticate API services.
This value will be assigned first according to any available environment value with a specified fallback.
Note that the reference implementations within this project rely on the supplied authenticate-node-server domain, localhost at the specified port.
Note also that the api service of your front-end implementation will need to be modified as required for use with other server implementations.
|
config.server.port
|
The server port assigned to API requests.
Note that the default for the reference applications is set to port 8081.
For further information, see information about the host property above.
|
Run Your Server
By default, the reference projects assume that the provided Node.js server housed in the authenticate-node-server directory is running on the specified port, which defaults to http://localhost:8081, according to the config.js settings described above.
To run your node server, use the node index.js command within your node-enabled authenticate-node-server directory.
Server tokens
When your project application is running, 6-digit authentication numbers (tokens) will be requested for entry by the user. These tokens will be generated and displayed in the Node.js console log, or wherever your server logs to. Cut and paste to complete the authentication. Alternatively you can configure a mail server to send these tokens via email. Use these where prompted.
Comments
0 comments
Please sign in to leave a comment.