Links

REST API

Installation & Running the Project

Make sure you have Docker or a JDK 16 build environment including Gradle installed on your machine
Docker
Local
Pull the docker container directly from docker hub and run the project
docker run -itv $(pwd)/data:/app/data waltid/ssikit serve
This will create a folder called data in your current directory as storge for the VC, DIDs, Keys and other things which need to be stored in order to provide all the fuctionality.
  1. 1.
    Clone the project
git clone https://github.com/walt-id/waltid-ssikit.git
2. Change the folder
cd waltid-ssikit/
3. Run the project
The first time you run the command you will be asked to built the project. You can confirm the prompt.
./ssikit.sh serve
If you want to get a more detailed overview of the options provided for building the project on your machine, please refer to building the project.
After successfully running the project, you will have the endpoints, described below, available for use. Make sure to get a general overview of the functionality exposed by each endpoint by visiting the URL and inspecting the swagger docs hosted thereunder. You can also use the publicly hosted version on walt.id for reference.
Exposed endpoints:
Type
Locally
General Available
Signatory API
http://127.0.0.1:7001
Custodian API
http://127.0.0.1:7002
Auditor API
http://127.0.0.1:7003
Core API
http://127.0.0.1:7000
ESSIF API
http://127.0.0.1:7004
The Core API exposes most of the funtionalities provided by the SSI Kit, however newer features will only be released in the other API endpoints. Therefore, it is recommended to use the Signatory API, Custodian API and Auditor API for most use cases.