docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,88 @@
+---
+description: 'Learn how to use Publishable API Keys in Client Requests using Medusa JS Client, Medusa React, or other methods.'
+---
+
+# Use Publishable API Keys in Client Requests
+
+In this document, you'll learn how to use Publishable API Keys in client requests.
+
+:::note
+
+[Publishable API keys](../index.mdx) are only for client-side use. They can be publicly accessible in your code, as they are not authorized for the Admin API.
+
+:::
+
+## Default Behaviour In Product Store Endpoints
+
+If you don't pass a publishable API Key for the store endpoints `/store/products` and `/store/products/{product_id}`, the default sales channel of the store is assigned to the request.
+
+---
+
+## Using Medusa JS Client
+
+When using [Medusa’s JS Client](../../../js-client/overview.md), you can pass it to the client only once when you create the instance of the client:
+
+```ts
+const medusa = new Medusa({
+  maxRetries: 3,
+  baseUrl: "https://api.example.com",
+  publishableApiKey,
+})
+```
+
+This will add the API key as in the header parameter `x-publishable-api-key` on all requests.
+
+You can also use the `setPublishableKey` method to set it at a later point:
+
+```ts
+const medusa = new Medusa({
+  // ...
+})
+
+// at a later point
+medusa.setPublishableKey(publishableApiKey)
+```
+
+---
+
+## Using Medusa React
+
+You can pass the publishable API key to the `MedusaProvider` component:
+
+```tsx
+const App = () => {
+  return (
+    <MedusaProvider
+      queryClientProviderProps={{ client: queryClient }}
+      baseUrl="http://localhost:9000"
+      // ...
+      publishableApiKey={publishableApiKey}
+    >
+      <MyStorefront />
+    </MedusaProvider>
+  )
+}
+```
+
+Then, the API key will be passed in the header parameter `x-publishable-api-key` of every request.
+
+---
+
+## Using Other Methods
+
+For other ways of sending requests to your Medusa backend, such as using the Fetch API, you must pass `x-publishable-api-key` in the header of every request. Its value is the publishable API key’s `id`.
+
+```ts
+fetch(`<BACKEND_URL>/store/products`, {
+  credentials: "include",
+  headers: {
+    "x-publishable-api-key": publishableApiKey,
+  },
+})
+```
+
+---
+
+## See Also
+
+- [Manage publishable keys as an admin](../admin/manage-publishable-api-keys.mdx)