Verification Service http://jincor.com
Switch branches/tags
Clone or download
Latest commit 8be9c7b Nov 29, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Closes #38. Add GET verification endpoint. Nov 28, 2017
src Closes #38. Add GET verification endpoint. Nov 28, 2017
.dockerignore Develop to Master (#12) Sep 22, 2017
.gitignore Add bash to the container Nov 10, 2017
.npmrc Develop to Master (#12) Sep 22, 2017
.nycrc Develop (#23) Nov 10, 2017
.travis.yml Develop (#23) Nov 10, 2017
Dockerfile Closes #38. Add GET verification endpoint. Nov 28, 2017
Dockerfile.prod Closes #38. Add GET verification endpoint. Nov 28, 2017
Jenkinsfile Develop to Master (#12) Sep 22, 2017
LICENSE Initiate commit. Sep 15, 2017
Logo.png Initiate commit. Sep 15, 2017
README.md Closes #37. Increase attempts count on failing code validation. Nov 28, 2017
apiary.apib Closes #38. Add GET verification endpoint. Nov 28, 2017
build.sh Develop (#23) Nov 10, 2017
codeship-services.yml Closes #31. Use REDIS_URL instead of host, port. Nov 23, 2017
codeship-steps.yml Develop (#23) Nov 10, 2017
deployment.env.encrypted Merge branch 'master' into develop Nov 10, 2017
docker-compose.prod.yml Closes #31. Use REDIS_URL instead of host, port. Nov 23, 2017
docker-compose.yml Closes #31. Use REDIS_URL instead of host, port. Nov 23, 2017
package.json Closes #38. Add GET verification endpoint. Nov 28, 2017
tsconfig.build.json Develop (#23) Nov 10, 2017
tsconfig.json Develop (#23) Nov 10, 2017
tslint.json Develop (#23) Nov 10, 2017
yarn.lock Closes #26 #28. Add mailjet integration. Rename EMAIL_DRIVER env to M… Nov 21, 2017

README.md

Jincor Verification Service

Jincor VERIFY Service

Jincor Verification is a service for verify users email, phone, and etc. The main responsibilities are:

  1. Interact with a service provider
  2. Validation of a received code

Take a look at our Wiki for more details.

API Endpoints Summary

For more details see the API docs

JWT_TOKEN should be passed for every API call in the HTTP headers, that was received from auth service.

  1. /methods/{METHOD}/actions/initiate [POST]
  2. /methods/{METHOD}/verifiers/{VERIFICATION_ID}/actions/validate [POST]
  3. /methods/{METHOD}/verifiers/{VERIFICATION_ID} [DELETE]

How to start development and run tests?

  1. Clone this repo.
  2. Run docker-compose build --no-cache.
  3. Run docker-compose up -d.
  4. To install dependencies run: docker-compose exec verify yarn.
  5. To run tests run: docker-compose exec verify yarn test.
  6. To build production image run docker-compose -f docker-compose.prod.yml build --no-cache.

How to generate docs?

  1. Install npm install -g aglio.
  2. Run mkdir /usr/local/lib/node_modules/aglio/node_modules/aglio-theme-olio/cache.
  3. Generate aglio --theme-variables cyborg --theme-template triple -i apiary.apib -o ./docs/index.html.