0462cc5acf
- Change existing data model guides and add new ones for DML - Change module's docs around service factory + remove guides that are now necessary - Hide/remove all mentions of module relationships, or label them as coming soon. - Change all data model creation snippets to use DML - use `property` instead of `field` when referring to a data model's properties. - Fix all snippets in commerce module guides to use new method suffix (no more main model methods) - Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML. ### Other changes - Highlight fixes in some guides - Remove feature flags guide - Fix code block styles when there are no line numbers. ### Upcoming changes in other PRs - Re-generate commerce module references (for the updates in the method names) - Ensure that the data model references are generated correctly for models using DML. - (probably at a very later point) revisit recipes
341 lines
7.2 KiB
Plaintext
341 lines
7.2 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
||
|
||
export const metadata = {
|
||
title: `Examples of the API Key Module`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this guide, you’ll find common examples of how you can use the API Key Module in your application.
|
||
|
||
## Create an API Key
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts
|
||
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
||
import { IApiKeyModuleService } from "@medusajs/types"
|
||
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||
|
||
export async function POST(
|
||
request: MedusaRequest,
|
||
res: MedusaResponse
|
||
) {
|
||
const apiKeyModuleService: IApiKeyModuleService =
|
||
request.scope.resolve(ModuleRegistrationName.API_KEY)
|
||
|
||
const apiKey = await apiKeyModuleService.createApiKeys({
|
||
title: "Publishable API key",
|
||
type: "publishable",
|
||
created_by: "user_123",
|
||
})
|
||
|
||
res.json({
|
||
api_key: apiKey,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import {
|
||
initialize as initializeApiKeyModule,
|
||
} from "@medusajs/api-key"
|
||
|
||
export async function POST(request: Request) {
|
||
const apiKeyModuleService = await initializeApiKeyModule()
|
||
|
||
const apiKey = await apiKeyModuleService.createApiKeys({
|
||
title: "Publishable API key",
|
||
type: "publishable",
|
||
created_by: "user_123",
|
||
})
|
||
|
||
return NextResponse.json({
|
||
api_key: apiKey,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## List API Keys
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts
|
||
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
||
import { IApiKeyModuleService } from "@medusajs/types"
|
||
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||
|
||
export async function GET(
|
||
request: MedusaRequest,
|
||
res: MedusaResponse
|
||
) {
|
||
const apiKeyModuleService: IApiKeyModuleService =
|
||
request.scope.resolve(ModuleRegistrationName.API_KEY)
|
||
|
||
res.json({
|
||
api_keys: await apiKeyModuleService.listApiKeys(),
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import {
|
||
initialize as initializeApiKeyModule,
|
||
} from "@medusajs/api-key"
|
||
|
||
export async function GET(request: Request) {
|
||
const apiKeyModuleService = await initializeApiKeyModule()
|
||
|
||
return NextResponse.json({
|
||
api_keys: await apiKeyModuleService.listApiKeys(),
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## Revoke an API Key
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts collapsibleLines="1-9" expandButtonLabel="Show Imports"
|
||
import {
|
||
AuthenticatedMedusaRequest,
|
||
MedusaResponse,
|
||
} from "@medusajs/medusa"
|
||
import { IApiKeyModuleService } from "@medusajs/types"
|
||
import {
|
||
ModuleRegistrationName,
|
||
} from "@medusajs/modules-sdk"
|
||
|
||
export async function POST(
|
||
request: AuthenticatedMedusaRequest,
|
||
res: MedusaResponse
|
||
) {
|
||
const apiKeyModuleService: IApiKeyModuleService =
|
||
request.scope.resolve(ModuleRegistrationName.API_KEY)
|
||
|
||
const revokedKey = await apiKeyModuleService.revoke(
|
||
request.params.id,
|
||
{
|
||
revoked_by: request.auth_context.actor_id,
|
||
}
|
||
)
|
||
|
||
res.json({
|
||
api_key: revokedKey,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import {
|
||
initialize as initializeApiKeyModule,
|
||
} from "@medusajs/api-key"
|
||
|
||
type ContextType = {
|
||
params: {
|
||
id: string
|
||
user_id: string
|
||
}
|
||
}
|
||
|
||
export async function POST(
|
||
request: Request,
|
||
{ params }: ContextType
|
||
) {
|
||
const apiKeyModuleService = await initializeApiKeyModule()
|
||
|
||
const revokedKey = await apiKeyModuleService.revoke(
|
||
params.id,
|
||
{
|
||
revoked_by: params.user_id,
|
||
}
|
||
)
|
||
|
||
return NextResponse.json({
|
||
api_key: revokedKey,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## Verify or Authenticate Token
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts
|
||
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
||
import { IApiKeyModuleService } from "@medusajs/types"
|
||
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||
|
||
export async function POST(
|
||
request: MedusaRequest,
|
||
res: MedusaResponse
|
||
) {
|
||
const apiKeyModuleService: IApiKeyModuleService =
|
||
request.scope.resolve(ModuleRegistrationName.API_KEY)
|
||
|
||
const authenticatedToken =
|
||
await apiKeyModuleService.authenticate(request.params.token)
|
||
|
||
res.json({
|
||
is_authenticated: !!authenticatedToken,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import {
|
||
initialize as initializeApiKeyModule,
|
||
} from "@medusajs/api-key"
|
||
|
||
type ContextType = {
|
||
params: {
|
||
token: string
|
||
}
|
||
}
|
||
|
||
export async function POST(
|
||
request: Request,
|
||
{ params }: ContextType
|
||
) {
|
||
const apiKeyModuleService = await initializeApiKeyModule()
|
||
|
||
const authenticatedToken =
|
||
await apiKeyModuleService.authenticate(request.params.token)
|
||
|
||
return NextResponse.json({
|
||
is_authenticated: !!authenticatedToken,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## Roll API Key
|
||
|
||
<CodeTabs groupId="app-type">
|
||
<CodeTab label="Medusa API Router" value="medusa">
|
||
|
||
```ts collapsibleLines="1-8" expandButtonLabel="Show Imports"
|
||
import {
|
||
AuthenticatedMedusaRequest,
|
||
MedusaResponse,
|
||
} from "@medusajs/medusa"
|
||
import { IApiKeyModuleService } from "@medusajs/types"
|
||
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||
|
||
export async function POST(
|
||
request: AuthenticatedMedusaRequest,
|
||
res: MedusaResponse
|
||
) {
|
||
const apiKeyModuleService: IApiKeyModuleService =
|
||
request.scope.resolve(ModuleRegistrationName.API_KEY)
|
||
|
||
const revokedKey = await apiKeyModuleService.revoke(
|
||
request.params.id,
|
||
{
|
||
revoked_by: request.auth_context.actor_id,
|
||
}
|
||
)
|
||
|
||
const newKey = await apiKeyModuleService.createApiKeys({
|
||
title: revokedKey.title,
|
||
type: revokedKey.type,
|
||
created_by: revokedKey.created_by,
|
||
})
|
||
|
||
res.json({
|
||
api_key: newKey,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
<CodeTab label="Next.js App Router" value="nextjs">
|
||
|
||
```ts
|
||
import { NextResponse } from "next/server"
|
||
|
||
import {
|
||
initialize as initializeApiKeyModule,
|
||
} from "@medusajs/api-key"
|
||
|
||
type ContextType = {
|
||
params: {
|
||
id: string
|
||
user_id: string
|
||
}
|
||
}
|
||
|
||
export async function POST(
|
||
request: Request,
|
||
{ params }: ContextType
|
||
) {
|
||
const apiKeyModuleService = await initializeApiKeyModule()
|
||
|
||
const revokedKey = await apiKeyModuleService.revoke(params.id, {
|
||
revoked_by: params.user_id,
|
||
})
|
||
|
||
const newKey = await apiKeyModuleService.createApiKeys({
|
||
title: revokedKey.title,
|
||
type: revokedKey.type,
|
||
created_by: revokedKey.created_by,
|
||
})
|
||
|
||
return NextResponse.json({
|
||
api_key: newKey,
|
||
})
|
||
}
|
||
```
|
||
|
||
</CodeTab>
|
||
</CodeTabs>
|
||
|
||
---
|
||
|
||
## More Examples
|
||
|
||
The [API Key Module's main service reference](/references/api-key) provides a reference to all the methods available for use with examples for each.
|