Skip to content

Commit

Permalink
Add getting started documentation (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
rwnd authored Mar 25, 2024
1 parent 228118f commit 97b55d5
Show file tree
Hide file tree
Showing 6 changed files with 101 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/10-getting_started/1-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 1
---
# Overview

Participating on OCEN 4.0 requires completion of the following four steps:

1. Participant onboarding
2. Tech readiness
3. Validation in UAT environment
4. Going live with the product network



19 changes: 19 additions & 0 deletions docs/10-getting_started/2-participant_onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
sidebar_position: 2
---
# 1. Participant onboarding
The Loan Journey [onboarding phase](../9-loan_journey/2-onboarding.md) requires participants to be registered with the OCEN registry. A pre-requisite for this step is that the participants - such as LA and Lenders, have finalized the product(s) they want to serve on the network and have signed legal contracts with each other for the same.

In order to onboard onto the OCEN registry:

1. Submit the [OCEN Contact form](https://ocen.dev/contact) to become a participant
2. Post approval, participants will receive an email with their auth credentials - *clientID* and *clientSecret*. These credentials are needed for validation of the tech readiness in the UAT environment.
3. If partcipant is Lender, the participant then gets to create the product on the OCEN registry (via the portal)
4. If partcipant is LA, the participant then gets to create the product network with the Lender and other participants (via the portal).
5. Partcipant then joins the product network on the registry (via the portal)

## OCEN 4.0 Wave 1

For Wave 1 of OCEN 4.0, the pre-requisite for the onboarding step is enabled manually by the OCEN team in a 1-1 fashion. Post applying via the form in Step 1 above, the OCEN team will match the participant with other participants needed for creation of the product and the product network. Once matched, the participants are expected to finalize their commercial agreements and sign legal contracts with each other.

Participants will then have to provide additional information to the OCEN team to complete their registration in the OCEN registry (such as their API endpoints and cryptographic public key) and will receive their auth credentials.
38 changes: 38 additions & 0 deletions docs/10-getting_started/3-tech_readiness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
sidebar_position: 3
---
# 2. Tech Readiness
The tech readiness step requires that the participant implements the OCEN Specs for their role as described at [OCEN 4.0 APIs](https://ocen.dev/apis). Note that implementation of the OCEN Spec can be completed without receiving the credentials from the [onboarding step](./2-participant_onboarding.md).

This requires the following:
1. Implementation of Auth
2. Implementation of Partcipant APIs

## Implementation of Auth

All participants must implement the authentication module to communicate with the OCEN registry and other participants. The details of the auth mechanism is already noted in the [Auth and Security](../7-auth_service/1-overview.md) section.

### OCEN-AuthStarter Project

Participants may choose to use the [OCEN-AuthStarter Project](https://github.com/iSPIRT/OCEN-AuthStarter) for understanding and implementing the auth menchanism. The project is an implementation of the Auth module in Java for a sample LA and a sample Lender role.

For each of those roles, the Auth module at the caller (client) performs the following:
1. Client calls the OCEN registry to fetch the access token
2. Client generates the paylod specific signature
3. Client makes an API call to the Provider with the signature and the token in the header

The Auth verification at the callee (Provider) performs the following:
1. Verifies the token from the public key URL in the OCEN registry
2. Fetches the Client's public key from the OCEN registry
3. Verifies the JWS Signature in the request before processesing the client request

## Implementation of Partcipant APIs

All participants must implement the OCEN Specs for their role as described at [OCEN 4.0 APIs](https://ocen.dev/apis). Implementation of any role requires communication with other participants in the network, especially since the OCEN 4.0 APIs follow a [Async design](../8-api_design_principles.md). An easy implementation and validation of the API specs for a given role (such as LA) will require a mock participants (such as a mock Lender) to be created that can return a configured response.

### OCEN-AuthStarter Project

The [OCEN-AuthStarter Project](https://github.com/iSPIRT/OCEN-AuthStarter) has an implementation of a sample LA and a sample Lender, sample product and a product network, and UAT config credentials for each role. The project allows for a sample `CreateLoanApplication` API call to be sent from the LA to Lender and a sample `CreateLoanApplicationResponse` API call to be sent from the Lender back to the LA.

The project may be used as a refernce to build out the API specs.

13 changes: 13 additions & 0 deletions docs/10-getting_started/4-uat_validation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 4
---
# 3. UAT Validation
The UAT envirponment for OCEN 4.0 is setup at `https://dev.ocen.network/`. Post completion of the Onboarding and the Tech Readiness steps, participants may validate their product and product network in the UAT environment.

A successful validation in the UAT environment requires that each participant that is to be part of the product network has completed the earlier two steps. They should be able to communicate with each other using the OCEN registry in the UAT and validate the end-to-end loan journey for serving their product.

## Tech Specs Certification

Participants must also get their OCEN Specs implementation certified by empanelled organisations that wish to provide independent certification services to members of the OCEN ecosystem. The certification process specifies a set of tests that all participants must pass, to verify their adherence to OCEN 4.0 Specification. This will include validation of the API implementation as well as adherance to standards such as sending Heartbeat API calls post every request, analytics API call for lender roles, etc.

The OCEN team will assit with the certification process for the OCEN 4.0 Wave 1 participants.
12 changes: 12 additions & 0 deletions docs/10-getting_started/5-going_live.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 5
---
# 4. Going Live
Upon completion of the earlier four steps the participants will be ready to take their product live and serve the borrowers on OCEN.

Going live requires:
1. Re-creation of the Product, Product Network in production environment
2. Participants updating their credentials with production credentials
3. Participants validating the end-to-end loan journey with a sample loan application

The OCEN team will assist with the above for the OCEN 4.0 Wave 1 participants.
5 changes: 5 additions & 0 deletions docs/10-getting_started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Getting Started",
"position": 10
}

0 comments on commit 97b55d5

Please sign in to comment.