Skip to content

Commit

Permalink
Added docs for Service Token
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesLawton committed Apr 5, 2024
1 parent 8088450 commit 6533790
Show file tree
Hide file tree
Showing 20 changed files with 13 additions and 279 deletions.
Binary file modified docs/pages/.DS_Store
Binary file not shown.
1 change: 0 additions & 1 deletion docs/pages/api.mdx

This file was deleted.

16 changes: 11 additions & 5 deletions docs/pages/api/metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,24 @@

The Sequence Metadata API service offers a simple and fast API to query, manage, and update collections, token & NFT metadata for Ethereum-compatible chains.



:::info
Our Metadata service is managed through [Sequence Builder](HTTPS://SEQUENCE.BUILD). Sign up to grab your
API access key before following the steps below.
Our Metadata service is managed through [Sequence Builder](HTTPS://SEQUENCE.BUILD) and requires a Service Account & Token in order to call the corresponding endpoints. Please follow the [section](/api/metadata#Obtaining a Service Account & Token) below prior to calling the endpoints
:::

## Obtaining a Service Account & Token
Since the Metadata API requires write access in order to update on-chain state, you will need to first obtain a Service Account & Token to call this from your backend. Importantly, this is a secret key and should not be exposed publicly.

1. Create a New Project using our [Builder](https://sequence.build). Navigate to Settings > API Keys > Add Service Account.
2. In the modal that pops up, click the dropdown for Permission and change to Write. After completed click Add.
3. On the next screen, you will be given your Secret API Token. Copy the key and store it securely as it is not possible to see it again. Once this is done, click Confirm and you are all set to utilize the API.

Keep in mind, in contrast to our Public API Access key - this Secret API Token should be stored securely and not be used publicly. You will pass this token as a normal JWT in the Request Headers as X-Access-Key


## Creating Collections, Tokens, and Managing Metadata
The below steps walk through an end to end example utilizing our Metadata API in order to deploy an NFT collection, create tokens within that collection, and deploy asset metadata to such as an image to that token.

1. [Call `CreateCollection` endpoint](https://0xsequence.redoc.ly/tag/metadata#operation/metadata-CreateCollection)
1. [Call `CreateCollection` endpoint](https://0xsequence.redoc.ly/tag/metadata#operation/metadata-CreateCollection) - ensure you pass in the Secret Service Token created in the prior section.

2. `CreateToken` - use returned collectionId from previous request

Expand Down
File renamed without changes.
1 change: 0 additions & 1 deletion docs/pages/builder.mdx

This file was deleted.

1 change: 0 additions & 1 deletion docs/pages/sdk.mdx

This file was deleted.

File renamed without changes.
53 changes: 0 additions & 53 deletions docs/pages/solutions/indexer/01-overview.mdx

This file was deleted.

108 changes: 0 additions & 108 deletions docs/pages/solutions/indexer/02-installation.mdx

This file was deleted.

Empty file.
Empty file.
Empty file.
91 changes: 0 additions & 91 deletions docs/pages/solutions/indexer/07-native-network-balance.mdx

This file was deleted.

Empty file.
File renamed without changes.
3 changes: 0 additions & 3 deletions docs/pages/stack.mdx

This file was deleted.

9 changes: 0 additions & 9 deletions docs/pages/support.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions docs/pages/wallet.mdx

This file was deleted.

5 changes: 2 additions & 3 deletions nav.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ export const topNav = [
}
]
},

{
text: 'Guides',
items: [
Expand Down Expand Up @@ -162,7 +161,7 @@ export const sidebar = {
text: 'Technical References',
items: [
{ text: 'Chain Support', link: '/solutions/technical-references/chain-support' },
{ text: 'Node Gateway', link: '/solutions/technical-references/node-gateway' },
{ text: 'EIP5189 vs. 4337', link: '/solutions/technical-references/5189-4337' },
{ text: 'Smart Contract Wallets', collapsed: true, items: [
{ text: 'Why smart contract wallets?', link: '/solutions/technical-references/wallet-contracts/01-why' },
{ text: 'Universal Deployer', link: '/solutions/technical-references/wallet-contracts/02-universal-deployer' },
Expand Down Expand Up @@ -287,7 +286,6 @@ export const sidebar = {
{ text: 'Custom Connectors', link: '/sdk/sequence-kit/05-custom-connectors' }
]
},

{ text: 'TypeScript', collapsed: true, items: [
{text: 'Connect Wallet', link: '/sdk/typescript/03-guides/01-connect-wallet'},
{text: 'Authenticate Users with Message Signature', link: '/sdk/typescript/03-guides/02-auth-address'},
Expand Down Expand Up @@ -347,6 +345,7 @@ export const sidebar = {
},
{ text: 'Relayer', link: '/api/relayer' },
{ text: 'Marketplace', link: '/api/marketplace' },
{ text: 'Node Gateway RPCs', link: '/api/node-gateway' },
{ text: 'Metadata', link: '/api/metadata' },
]
},
Expand Down

0 comments on commit 6533790

Please sign in to comment.