Installation
To install for a mobile or web application use the following
npm install clinical6 --save
Requirements
Before you start coding, you'll need to set up your development environment:
Software | Version | Instructions | Purpose |
---|---|---|---|
NodeJS | 5.5.0 | Go to nodejs.org, download Node, and install with default settings using your machine's default installer | JavaScript engine |
NPM | 3.3.12 | Node Package Manager (NPM) is included in the default installation of Node | Package manager |
Any JS IDE | -- | Choose an IDE that supports JavaScript coding (e.g. Webstorm v11.0.3+ or Sublime Text 3) | JavaScript IDE |
Git | ^2.5.0 | Download, install, and verify "git" is an executable command from your terminal | Version Control |
Testing server availability
This is a client library that depends on already having a working Clinical6 endpoint. You can quickly verify your endpoint using the following command:
curl -H "Content-Type: application/json" -X POST -d '{"device":{"udid":"sampleid","technology":"ios","push_id":"abc","app_version":"1.0"}}' https://mysite.captivereach.com/api/mobile_users/sign_in_guest
The curl command above should return an alphanumeric auth_token
in its response.