docs(index.md): add architecture integration section

Signed-off-by: jrhender <[email protected]>
openwallet-foundation-labs · Jan 28, 2025 · 0422544 · 0422544
1 parent 8c99ef7
commit 0422544
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -17,6 +17,19 @@ This means that VC API can be used by an organization or user to issue and verif
 - **Composability**: VC API provides primitives which can be composed to create more complex operations. For example, the "workflow" primitive can be used to create a sequence of operations or be combined with other protocols such as OID4VP.
 - **Extensibility**: VC API is designed to be extensible. For example, OAuth2 is specified as an authorization mechanism but other mechanisms can be also be used.
 
+## How to use VC API in your architecture
+
+The VC API architecture defines [coordinator](https://w3c-ccg.github.io/vc-api/#coordinators) and [service](https://w3c-ccg.github.io/vc-api/#services) components.
+The VC API endpoints are on the service components and are called by coordinators, by other services, or by clients directly.
+The expected callers of the VC API endpoints are listed in the specification [component overview](https://w3c-ccg.github.io/vc-api/#api-component-overview).
+The relationship between the components is shown in the diagram below.
+
+![VC API Components](https://w3c-ccg.github.io/vc-api/diagrams/components.svg)
+
+As the project is an implementation of the VC API specification, the project provides the service components and is flexible in how the coordinator components are implemented.
+The coordinator executes the business rules and policies and is therefore specific to the use cases of an organization.
+*A first step to integrate the VC API implementation into your architecture could therefore be to decide how you want to define the business logic to coordinate VC API calls for your use case.*
+
 ## Why use this implementation?
 - **Open Source**: This implementation is open source and free to use, under an Apache 2.0 license.
 - **Integration with OWF**: This implementation is part of the Open Wallet Foundation ecosystem and strives to be compatible with other OWF projects. In particular, this implementation uses the [OWF Credo project](https://github.com/openwallet-foundation/credo-ts) as the underlying project for credential operations.