ebca8fed28
* revise API Key Module overview * revise auth module * support ref sidebar items * remove examples * revise cart module * revise currency * revise customer module * revise fulfillment module * revise inventory module * revise order module * revise payment * revise pricing module * revise product module * revise promotion module * revise region module * revise sales channel module * revise stock location module * revise store module * revise tax module * revise user module * lint content + fix snippets
110 lines
2.6 KiB
Plaintext
110 lines
2.6 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
|
|
|
export const metadata = {
|
|
title: `Links between API Key Module and Other Modules`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
This document showcases the module links defined between the API Key Module and other commerce modules.
|
|
|
|
## Summary
|
|
|
|
The API Key Module has the following links to other modules:
|
|
|
|
- [`ApiKey` data model \<\> `SalesChannel` data model of Sales Channel Module](#sales-channel-module).
|
|
|
|
---
|
|
|
|
## Sales Channel Module
|
|
|
|
You can create a publishable API key and associate it with a sales channel. Medusa defines a link between the `ApiKey` and the `SalesChannel` data models.
|
|
|
|
|
|
|
|
This is useful to avoid passing the sales channel's ID as a parameter of every request, and instead pass the publishable API key in the header of any request to the Store API route.
|
|
|
|
Learn more about this in the [Sales Channel Module's documentation](../../sales-channel/publishable-api-keys/page.mdx).
|
|
|
|
### Retrieve with Query
|
|
|
|
To retrieve the sales channels of an API key with [Query](!docs!/learn/fundamentals/module-links/query), pass `sales_channels.*` in `fields`:
|
|
|
|
<CodeTabs group="relation-query">
|
|
<CodeTab label="query.graph" value="method">
|
|
|
|
```ts
|
|
const { data: apiKeys } = await query.graph({
|
|
entity: "api_key",
|
|
fields: [
|
|
"sales_channels.*",
|
|
],
|
|
})
|
|
|
|
// apiKeys.sales_channels
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="useQueryGraphStep" value="step">
|
|
|
|
```ts
|
|
import { useQueryGraphStep } from "@medusajs/medusa/core-flows"
|
|
|
|
// ...
|
|
|
|
const { data: apiKeys } = useQueryGraphStep({
|
|
entity: "api_key",
|
|
fields: [
|
|
"sales_channels.*",
|
|
],
|
|
})
|
|
|
|
// apiKeys.sales_channels
|
|
```
|
|
|
|
</CodeTab>
|
|
</CodeTabs>
|
|
|
|
### Manage with Remote Link
|
|
|
|
To manage the sales channels of an API key, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
|
|
|
|
<CodeTabs group="relation-link">
|
|
<CodeTab label="remoteLink.create" value="method">
|
|
|
|
```ts
|
|
import { Modules } from "@medusajs/framework/utils"
|
|
|
|
// ...
|
|
|
|
await remoteLink.create({
|
|
[Modules.API_KEY]: {
|
|
api_key_id: "apk_123",
|
|
},
|
|
[Modules.SALES_CHANNEL]: {
|
|
sales_channel_id: "sc_123",
|
|
},
|
|
})
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="createRemoteLinkStep" value="step">
|
|
|
|
```ts
|
|
import { Modules } from "@medusajs/framework/utils"
|
|
import { createRemoteLinkStep } from "@medusajs/medusa/core-flows"
|
|
|
|
// ...
|
|
|
|
createRemoteLinkStep({
|
|
[Modules.API_KEY]: {
|
|
api_key_id: "apk_123",
|
|
},
|
|
[Modules.SALES_CHANNEL]: {
|
|
sales_channel_id: "sc_123",
|
|
},
|
|
})
|
|
```
|
|
|
|
</CodeTab>
|
|
</CodeTabs> |