Commit 50e32a8e authored by Peter Langenkamp's avatar Peter Langenkamp

updated documentation to describe the SSI Service Provider

parent 5e98260d
# Documentation for using the ssi service
These files provide a description of the REST api for interacting with the ssi service, several api’s are available.
- [Create JWT](./rest-api/create-jwt.md)
- [Credential Issue Request](./rest-api/credential-issue-request.md)
- [Credential Verify Request](./rest-api/credential-verify-request.md)
- [Register Credential Type (Jolocom)](./rest-api/register-credential-type-jolocom.md)
- [Register Organization's Credential Types](./rest-api/register-organizations-credential-types.md)
- [Register Organization](./rest-api/register-organization.md)
- [Registered Credential Type (Jolocom)](./rest-api/registered-credential-type-jolocom.md)
- [Registered Organization's Credential Types](./rest-api/registered-organizations-credential-types.md)
- [Registered Organizations](./rest-api/registered-organizations.md)
For a description of the content of jwt tokens, refer to
- [Issue Request](./jwt-descriptions/jwt-credential-issue-request)
- [Issue Response](./jwt-descriptions/jwt-credential-issue-response)
- [Verify Request](./jwt-descriptions/jwt-credential-verify-request)
- [Verify Response](./jwt-descriptions/jwt-credential-verify-request)
- [Create JWT](./jwt-descriptions/response-jwt-create-jwt)
\ No newline at end of file
# SSI Service Provider — Working with credentials made easy
Do you want to issue or verify credentials, but lack either the time, manpower, interest, or experience to implement this yourself? Or do you simply want to avoid the hastle of implementing support for multiple different wallets, and dealing with (breaking) changes on their end? Then you may want to consider our SSI service!
> The SSI Service Provider strives to improve the usability of SSI in real life by providing basic functionality that assists in issuing and verifying credentials to and from multiple wallets.
Similar to a payment service provider allowing webshops to easilly support payment with MasterCard, Visa, PayPal, iDeal, bitcoin, and you name it, our objective is to faciliatate issuing and verifying to and from any of the popular SSI wallets. We currently support IRMA, Jolocom, and Hyperledger Indy, with more to come.
Sounds interesting? Or have any questions? Please let us know and we'll help you get up and running with our SSI service, or discuss your needs for credentials.
 
## Getting started
For information on how to integrate with our service, please contact [Peter Langenkamp](mailto:peter.langenkamp@tno.nl&cc=michiel.stornebrink@tno.nl), or refer to our documentation [here](./documentation.md).
 
## Try it out!
To quickly try out different aspects of the service, we encourage you to go to the utils page of our service. Here, you can register a new organization, define credential types, and manually create issue and verify requests for testing purposes. Detailed information on using these utilities can be found [here](./service-instructions/utils-overview.md). If you know what you are doing, you can go to the issue or verify page directly.
- [Utils](https://service.essif-lab-ssi.dev.grnet.gr/utils) [[?](./service-instructions/utils-overview.md)]
- [Issue](https://service.essif-lab-ssi.dev.grnet.gr/issue/someToken)
- [Verify](https://service.essif-lab-ssi.dev.grnet.gr/verify/someToken)
\ No newline at end of file
# Documentation for using the ssi service
While the SSI service can be used through our [utils page](https://service.essif-lab-ssi.dev.grnet.gr/utils), for practical use you can interact with the service directly through the available APIs. The files below provide a description of the REST api for interacting with the ssi service.
- [Create JWT](./rest-api/create-jwt.md)
- [Credential Issue Request](./rest-api/credential-issue-request.md)
- [Credential Verify Request](./rest-api/credential-verify-request.md)
- [Register Credential Type (Jolocom)](./rest-api/register-credential-type-jolocom.md)
- [Register Organization's Credential Types](./rest-api/register-organizations-credential-types.md)
- [Register Organization](./rest-api/register-organization.md)
- [Registered Credential Type (Jolocom)](./rest-api/registered-credential-type-jolocom.md)
- [Registered Organization's Credential Types](./rest-api/registered-organizations-credential-types.md)
- [Registered Organizations](./rest-api/registered-organizations.md)
For a description of the content of the different jwt tokens, refer to
- [Issue Request](./jwt-descriptions/jwt-credential-issue-request)
- [Issue Response](./jwt-descriptions/jwt-credential-issue-response)
- [Verify Request](./jwt-descriptions/jwt-credential-verify-request)
- [Verify Response](./jwt-descriptions/jwt-credential-verify-request)
- [Create JWT](./jwt-descriptions/response-jwt-create-jwt)
 
## Connecting a new wallet app
Interested in connecting to our service? Please let us know by sending an email to [Peter Langenkamp](mailto:peter.langenkamp@tno.nl).
\ No newline at end of file
# Create token
Create tokens for testing the issuance and verifications of credentials.
## Create request token
1. Select the organization for which you want to issue / verify credentials.
2. Select the organization-specific credential type you want to issue / verify.
3. Enter the callback url to which the user will be redirected. The response JWT will be appended to this URL.
4. Select whether you want to create a credential issue or verify request
* In case of an issue request, enter the credential data to be issued.
5. Submit.
## Example
For example, to create an issue request:
![Create Request Token](../images/CreateRequestToken.png)
If you go to the issue page with this token, you can choose which wallet you want to use to store the credential:
![Select Wallet](../images/SelectWallet.png)
## Debug token
Submit the request token for debug purposes.
\ No newline at end of file
# Jolocom types
Define Jolocom credential types.
## Define Jolocom Type
1. Provide a user-friendly name for the new Jolocom credential type.
2. Name the identifier for the new Jolocom credential type.
3. Provide the claim interface for the new Jolocom credential type.
4. Provide the context for the new Jolocom credential type.
5. Submit.
## Example
For example, an email credential could be defined as follows:
![Define Jolocom Type](../images/DefineJolocomType.png)
\ No newline at end of file
# Credential types
Define a mapping of organization specific credential types to general credential types (e.g. IRMA, Jolocom, ...).
## Define Credential type
1. Select the organization for which you whish to define a new credential type.
2. Name the organization-specific credential type.
3. Select the Jolocom credential type to associate with the new credential type.
4. Provide the IRMA credential type to associate with the new credential type.
5. Submit.
\ No newline at end of file
# Organizations
Register your organization. This allows you to issue and verify credentials using our SSI service.
## Register Organization
1. Enter the name of your organization
2. Submit. *(Registration may take a minute.)*
3. The registration response contains the uuid and sharedSecret.
## Example
For example, to define a mapping for an email credential:
![Register Organization](../images/RegisterOrganization.png)
\ No newline at end of file
# Utils overview
We currently offer the following utilities:
- ## [Create token](./create-token.md)
Create tokens for testing the issuance and verifications of credentials.
- ## [Organizations](./register-organization.md)
Register your organization. This allows you to issue and verify credentials using our SSI service.
- ## [Credential types](./define-credential-mapping.md)
Define a mapping of organization specific credential types to general credential types (e.g. IRMA, Jolocom, ...).
- ## [Jolocom types](./define-jolocom-types.md)
Define Jolocom credential types.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment