/credence-api

Web API for secure credential storage service

Primary LanguageRubyGNU General Public License v3.0GPL-3.0

Credence API

API to store and retrieve confidential development files (configuration, credentials)

Routes

All routes return Json

  • GET /: Root route shows if Web API is running
  • GET api/v1/document/: returns all confiugration IDs
  • GET api/v1/document/[ID]: returns details about a single document with given ID
  • POST api/v1/document/: creates a new document

Install

Install this API by cloning the relevant branch and installing required gems from Gemfile.lock:

bundle install

Test

Run the test script:

ruby spec/api_spec.rb

Execute

Run this API using:

rackup