Skip to content

Update SDK API key usage #363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 9, 2025
Merged

Update SDK API key usage #363

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bbc80ec
feat: update migration guide
jkoenig134 Jul 9, 2025
c233fa8
feat: add example
jkoenig134 Jul 9, 2025
acc9a74
chore: update title
jkoenig134 Jul 9, 2025
7a38b6b
chore: commas
jkoenig134 Jul 9, 2025
243f224
chore: casing
jkoenig134 Jul 9, 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
13 changes: 13 additions & 0 deletions _docs_integrate/migration-from-v6-to-v7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,19 @@ The step-by-step instructions can be consulted to start the migration to version
- For the same reason, the `onlyValid` parameter was removed from the use cases [Get Attributes]({% link _docs_use-cases/use-case-consumption-get-attributes.md %}), [Get own shared Attributes]({% link _docs_use-cases/use-case-consumption-get-own-shared-attributes.md %}) and [Get peer shared Attributes]({% link _docs_use-cases/use-case-consumption-get-peer-shared-attributes.md %}).
Accordingly, it was removed from the associated Connector routes as well.

### TypeScript SDK Changes

With every version of the Connector, we ship a matching [TypeScript SDK]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk). With version 7 of the SDK, the deprecated field `apiKey` was removed. To access the Connector using an API key, you can configure the SDK now as follows:

```typescript
import { ApiKeyAuthenticator, ConnectorClient } from "@nmshd/connector-sdk";

const connectorClient = ConnectorClient.create({
baseUrl: "https://<INSERT_YOUR_CONNECTOR_DOMAIN_HERE>",
authenticator: new ApiKeyAuthenticator("<INSERT_YOUR_API_KEY_HERE>")
});
```

## Runtime-Specific Breaking Changes

As an Integrator of a Connector, the following changes do not need to be taken into account during migration to version 7, as they are Runtime-specific breaking changes handled internally by the Connector.
Expand Down