diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 964419be3..58e770844 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -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://", + authenticator: new ApiKeyAuthenticator("") +}); +``` + ## 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.