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
30 lines
1.0 KiB
Plaintext
30 lines
1.0 KiB
Plaintext
export const metadata = {
|
||
title: `API Key Concepts`,
|
||
}
|
||
|
||
# {metadata.title}
|
||
|
||
In this document, you’ll learn how about the different types of API keys, and their expiration and verification.
|
||
## API Key Types
|
||
|
||
There are two types of API keys:
|
||
|
||
- `publishable`: A public key used in client applications, such as a storefront.
|
||
- `secret`: A secret key used for authentication and verification purposes, such as an admin user’s authentication token or a password reset token.
|
||
|
||
The API key’s type is stored in the `type` property of the [ApiKey data model](/references/api-key/models/ApiKey).
|
||
|
||
---
|
||
|
||
## API Key Expiration
|
||
|
||
An API key expires when it’s revoked using the [revoke method of the module’s main service](/references/api-key/revoke).
|
||
|
||
The associated token is no longer usable or verifiable.
|
||
|
||
---
|
||
|
||
## Token Verification
|
||
|
||
To verify a token received as an input or in a request, use the [authenticate method of the module’s main service](/references/api-key/authenticate) which validates the token against all non-expired tokens.
|