Skip to content
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
cf28b50
refactor: new lines for scenario overview
britsta Nov 3, 2025
25de229
refactor: new lines for Connector access scenario
britsta Nov 3, 2025
0ba0096
feat: new lines for integration example
britsta Nov 3, 2025
295664d
refactor: new lines for establish Relationships scenario
britsta Nov 3, 2025
8bdf772
refactor: some new lines for copy-notice descriptions
britsta Nov 3, 2025
cd9835d
refactor: new lines for exchange Messages scenario
britsta Nov 3, 2025
146da27
refactor: new lines for terminate Relationships scenario
britsta Nov 3, 2025
57719ec
refactor: new lines for delete Identities scenario
britsta Nov 3, 2025
ac12ada
refactor: new lines for Request and Response introduction
britsta Nov 3, 2025
0a52f76
refactor: new lines for Requests via RelationshipTemplates scenario
britsta Nov 3, 2025
ccb1910
refactor: new lines for Requests via Messages scenario
britsta Nov 3, 2025
2da98fe
refactor: new lines for request persistent consent scenario
britsta Nov 3, 2025
c4e1030
refactor: new lines for request one-time consent scenario
britsta Nov 3, 2025
0a9bcf8
refactor: new lines for Attribute introduction
britsta Nov 3, 2025
6f0a68b
refactor: new lines for create Attributes for yourself scenario
britsta Nov 3, 2025
b6ec773
refactor: new lines for share Attributes with peer scenario
britsta Nov 3, 2025
d62ca11
refactor: new lines for read Attributes from peer scenario
britsta Nov 3, 2025
6b9b914
refactor: new lines for create Attributes for peer scenario
britsta Nov 3, 2025
85dd009
refactor: new lines for propose Attributes to peer scenario
britsta Nov 3, 2025
e3ddd14
refactor: new lines for Attribute succession scenario
britsta Nov 3, 2025
63df25a
refactor: new lines for data model overview
britsta Nov 3, 2025
d90c95e
refactor: new lines for Attribute values scenario
britsta Nov 3, 2025
aab97cf
refactor: new lines for error codes
britsta Nov 3, 2025
1f82802
refactor: new lines for FAQ
britsta Nov 3, 2025
4da0e95
refactor: new line for support page
britsta Nov 3, 2025
7f8ae52
refactor: new lines for v5 migration guide
britsta Nov 3, 2025
1095247
refactor: new line for v6 migration guide
britsta Nov 3, 2025
7f318e5
refactor: new lines for v7 migration guide
britsta Nov 3, 2025
37cdcde
Merge branch 'release/v7' into refactor/start-each-scenario-sentence-…
britsta Nov 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions _docs_integrate/01-integrate-scenarios.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,49 @@ sidebar:
nav: "docs_integrate"
---

You want to seamlessly use enmeshed with your processes, solutions and software components? No worries, you are good to go!
You want to seamlessly use enmeshed with your processes, solutions and software components?
No worries, you are good to go!

We've built the enmeshed Connector exactly for this scenario: to integrate existing systems with the enmeshed approach with as little effort as possible.

Here you'll find everything you need to seamlessly dive into the world of enmeshed and integrate it into your applications and systems. Whether you're just starting out or are already familiar with enmeshed, our comprehensive guide and resources are at your disposal.
Here you'll find everything you need to seamlessly dive into the world of enmeshed and integrate it into your applications and systems.
Whether you're just starting out or are already familiar with enmeshed, our comprehensive guide and resources are at your disposal.

## Getting Started

Begin your integration journey by familiarizing yourself with the [Connector REST API]({% link _docs_integrate/access-the-connector.md %}) and exploring the fundamental steps for integration. Gain insights into effectively utilizing the [Connector SDKs]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk) to streamline and optimize your integration. To get a first impression of certain integration processes, take a look at our [Integration example]({% link _docs_integrate/integration-example.md %}). Discover how events work and how you can leverage them in your application in the [Event introduction]({% link _docs_integrate/event-introduction.md %}).
Begin your integration journey by familiarizing yourself with the [Connector REST API]({% link _docs_integrate/access-the-connector.md %}) and exploring the fundamental steps for integration.
Gain insights into effectively utilizing the [Connector SDKs]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk) to streamline and optimize your integration.
To get a first impression of certain integration processes, take a look at our [Integration example]({% link _docs_integrate/integration-example.md %}).
Discover how events work and how you can leverage them in your application in the [Event introduction]({% link _docs_integrate/event-introduction.md %}).

## Identities and Relationships

Learn how to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to another Identity in order to be able to communicate and exchange information with it. Explore how to [exchange Messages]({% link _docs_integrate/exchange-messages.md %}) using enmeshed to communicate simply and securely with your peers. Furthermore, discover how to [terminate Relationships]({% link _docs_integrate/terminate-relationships.md %}), [delete Identities]({% link _docs_integrate/delete-identities.md %}) and [manage IdentityMetadata]({% link _docs_integrate/manage-identitymetadata.md %}).
Learn how to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to another Identity in order to be able to communicate and exchange information with it.
Explore how to [exchange Messages]({% link _docs_integrate/exchange-messages.md %}) using enmeshed to communicate simply and securely with your peers.
Furthermore, discover how to [terminate Relationships]({% link _docs_integrate/terminate-relationships.md %}), [delete Identities]({% link _docs_integrate/delete-identities.md %}) and [manage IdentityMetadata]({% link _docs_integrate/manage-identitymetadata.md %}).

## Working With Requests

Learn how to create and manage Requests. Check out the [Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}) and the [Requests via RelationshipTemplates]({% link _docs_integrate/requests-via-relationshiptemplates.md %}) and [Requests via Messages]({% link _docs_integrate/requests-via-messages.md %}) guides.
Learn how to create and manage Requests.
Check out the [Request and Response introduction]({% link _docs_integrate/request-and-response-introduction.md %}) and the [Requests via RelationshipTemplates]({% link _docs_integrate/requests-via-relationshiptemplates.md %}) and [Requests via Messages]({% link _docs_integrate/requests-via-messages.md %}) guides.

## Manage Attributes

The [Attribute introduction]({% link _docs_integrate/attribute-introduction.md %}) provides an overview of the different kinds of Attributes and the Attribute management options. Next, explore how to [create Attributes for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}) and how to [share Attributes]({% link _docs_integrate/share-attributes-with-peer.md %}) with a peer. Also, discover how to [read Attributes]({% link _docs_integrate/read-attributes-from-peer.md %}) from a peer and how to store Attributes in a peer's Wallet for them. The latter can be realized by [creating Attributes]({% link _docs_integrate/create-attributes-for-peer.md %}) for them or by [proposing Attributes]({% link _docs_integrate/propose-attributes-to-peer.md %}) to them. The peer must give you their permission for this. Furthermore, learn how to [update Attributes by succession]({% link _docs_integrate/update-attributes-by-succession.md %}) or how to [delete Attributes]({% link _docs_integrate/delete-attributes.md %}).
The [Attribute introduction]({% link _docs_integrate/attribute-introduction.md %}) provides an overview of the different kinds of Attributes and the Attribute management options.
Next, explore how to [create Attributes for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}) and how to [share Attributes]({% link _docs_integrate/share-attributes-with-peer.md %}) with a peer.
Also, discover how to [read Attributes]({% link _docs_integrate/read-attributes-from-peer.md %}) from a peer and how to store Attributes in a peer's Wallet for them.
The latter can be realized by [creating Attributes]({% link _docs_integrate/create-attributes-for-peer.md %}) for them or by [proposing Attributes]({% link _docs_integrate/propose-attributes-to-peer.md %}) to them.
The peer must give you their permission for this.
Furthermore, learn how to [update Attributes by succession]({% link _docs_integrate/update-attributes-by-succession.md %}) or how to [delete Attributes]({% link _docs_integrate/delete-attributes.md %}).

## Request Consent

Discover how to request [persistent consent]({% link _docs_integrate/request-persistent-consent-of-peer.md %}) and [one-time consent]({% link _docs_integrate/request-one-time-consent-of-peer.md %}) of a peer.

## Data Model

Understand the [Data Model]({% link _docs_integrate/data-model-overview.md %}) of enmeshed and how it fits into your integration. Also get an overview of the [Attribute Values]({% link _docs_integrate/attribute-values.md %}), the [Connector Events]({% link _docs_integrate/connector-events.md %}) and our [Use Cases]({% link _docs_integrate/use-cases.md %}).
Understand the [Data Model]({% link _docs_integrate/data-model-overview.md %}) of enmeshed and how it fits into your integration.
Also get an overview of the [Attribute Values]({% link _docs_integrate/attribute-values.md %}), the [Connector Events]({% link _docs_integrate/connector-events.md %}) and our [Use Cases]({% link _docs_integrate/use-cases.md %}).

## Migration Guides

Expand Down
16 changes: 11 additions & 5 deletions _docs_integrate/access-the-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,17 @@ required_by:
# End automatic generation
---

The primary integration capability of the Connector is the REST API. In order to use it, you should have received an API-Key for the respective Connector. An API-Key so far has all authorizations for accessing the API.
The primary integration capability of the Connector is the REST API.
In order to use it, you should have received an API-Key for the respective Connector.
An API-Key so far has all authorizations for accessing the API.

# Hosted API tooling by the (development) Connector

In order to use the hosted api tooling, it must be activated in the [Connector configuration]({% link _docs_operate/setup-with-docker-compose.md %}#hosted-api-tooling-by-the-development-connector).
{: .notice--warning}

You can access the REST API documentation through the Connector's designated HTTP endpoints. Swagger and Rapidoc serve as interactive platforms hosted on the Connector, enabling you to explore and experiment with the various APIs interactively.
You can access the REST API documentation through the Connector's designated HTTP endpoints.
Swagger and Rapidoc serve as interactive platforms hosted on the Connector, enabling you to explore and experiment with the various APIs interactively.

## Swagger

Expand All @@ -57,11 +60,14 @@ You can view these files with the [Swagger Editor](https://editor.swagger.io/) o

# Accessing the Connector by Software Development Kits (SDK)

To achieve a better developer experience and type safety, preferably a Software Development Kit (SDK) should be used. The following SDKs are available for this purpose:
To achieve a better developer experience and type safety, preferably a Software Development Kit (SDK) should be used.
The following SDKs are available for this purpose:

We work on keeping this list as updated as possible. Please let us know, if some SDKs are outdated or new SDKs are available for the community.
We work on keeping this list as updated as possible.
Please let us know, if some SDKs are outdated or new SDKs are available for the community.
{: .notice--info}

## TypeScript SDK

We offer an SDK developed in TypeScript that facilitates communication with your Connector from your TypeScript or JavaScript application. You can find it readily available on [npmjs](https://www.npmjs.com/package/@nmshd/connector-sdk).
We offer an SDK developed in TypeScript that facilitates communication with your Connector from your TypeScript or JavaScript application.
You can find it readily available on [npmjs](https://www.npmjs.com/package/@nmshd/connector-sdk).
Loading