diff --git a/build/1-apillon-api.md b/build/1-apillon-api.md index 02a8cb36..ff611c14 100644 --- a/build/1-apillon-api.md +++ b/build/1-apillon-api.md @@ -237,3 +237,7 @@ If a project's credit balance is lower than price of executed action, API will r ... } ``` + +## API Code Examples + +Examples for using the Apillon API in PHP, .NET (C#) and Python can be found on [our code examples github repo](https://github.com/Apillon/code-examples) \ No newline at end of file diff --git a/build/4-nfts-api.md b/build/4-nfts-api.md index 73d66ad8..75419b9e 100644 --- a/build/4-nfts-api.md +++ b/build/4-nfts-api.md @@ -41,6 +41,7 @@ API is for creating and managing NFTs. To prepare images and metadata you can us | baseExtension | `string` | File extension that is auto appended after token id to form a full URL. | | isSoulbound | `boolean` | Soul bound tokens are NFTs that are bounded to wallet and not transferable. | | isRevokable | `boolean` | For revocable collection owner can destroy NFTs at any time. | +| isAutoIncrement | `boolean` | If set to false, enables minting NFTs with a custom token ID | | royaltiesFees | `number` | Percentage (between 0 and 100) of each NFT sale sent to wallet specified under royalties address. | | royaltiesAddress | `string` | Address where royalties are sent to. | | collectionStatus | `number` | Apillon internal/database collection status. | @@ -324,24 +325,25 @@ Collection can be created with a few features/functionalities: #### Body fields -| Name | Type | Description | Required | -| ---------------- | --------- | ---------------------------------------------------------------------------------------- | -------- | -| collectionType | `number` | Type of smart contract to use when deploying collection (1 for generic, 2 for nestable). | true | -| chain | `number` | Blockchain id on which you want to release your collection. | true | -| symbol | `string` | NFT collection symbol (usually 3-4 characters long). | true | -| name | `string` | NFT collection name. | true | -| description | `string` | NFT collection description. | false | -| maxSupply | `number` | Maximal number of NFTs ever in existence (0 stands for unlimited). | true | -| baseUri | `string` | Base URI for collection metadata (token id and file extension is appended to it). | true | -| baseExtension | `string` | File extension that is auto appended after token id to form a full URL. | true | -| isRevokable | `boolean` | For revocable collection owner can destroy NFTs at any time. | true | -| isSoulbound | `boolean` | Soul bound tokens are NFTs that are bound to wallet and not transferable. | true | -| royaltiesAddress | `string` | Address where royalties are sent to. | true | -| royaltiesFees | `number` | Percentage of royalties earned per each NFT trade. | true | -| drop | `boolean` | Determines if collection is mintable by public. | true | -| dropStart\* | `number` | UNIX timestamp (in seconds) which determines public mint opening date and time. | true | -| dropPrice\* | `number` | Price of NFT at mint stage. | true | -| dropReserve\* | `number` | Amount of NFTs reserved by owner. | true | +| Name | Type | Description | Required | +| ---------------- | --------- | ---------------------------------------------------------------------------------------------------------- | -------- | +| collectionType | `number` | Type of smart contract to use when deploying collection (1 for generic, 2 for nestable). | true | +| chain | `number` | Blockchain id on which you want to release your collection. | true | +| symbol | `string` | NFT collection symbol (usually 3-4 characters long). | true | +| name | `string` | NFT collection name. | true | +| description | `string` | NFT collection description. | false | +| maxSupply | `number` | Maximal number of NFTs ever in existence (0 stands for unlimited). | true | +| baseUri | `string` | Base URI for collection metadata (token id and file extension is appended to it). | true | +| baseExtension | `string` | File extension that is auto appended after token id to form a full URL. | true | +| isRevokable | `boolean` | For revocable collection owner can destroy NFTs at any time. | true | +| isSoulbound | `boolean` | Soul bound tokens are NFTs that are bound to wallet and not transferable. | true | +| royaltiesAddress | `string` | Address where royalties are sent to. | true | +| royaltiesFees | `number` | Percentage of royalties earned per each NFT trade. | true | +| drop | `boolean` | Determines if collection is mintable by public. | true | +| dropStart\* | `number` | UNIX timestamp (in seconds) which determines public mint opening date and time. | true | +| dropPrice\* | `number` | Price of NFT at mint stage. | true | +| dropReserve\* | `number` | Amount of NFTs reserved by owner. | true | +| isAutoIncrement | `boolean` | If set to false, enables minting NFTs with a custom token ID, otherwise defaults to isAutoIncrement = true | false | **Notes:** diff --git a/build/6-apillon-cli.md b/build/6-apillon-cli.md index 8fc9abbc..ff1c47de 100644 --- a/build/6-apillon-cli.md +++ b/build/6-apillon-cli.md @@ -376,11 +376,14 @@ Upload contents of a local folder to specified bucket. - ``: Path to the folder containing your files. - `-b, --bucket-uuid `: UUID of the bucket to upload files to. +- `-w, --wrap`: Wrap uploaded files to an IPFS directory +- `-p, --path `: Path to upload files to (e.g. main/subdir). Required when --wrap is supplied. +- `--await`: await file CIDs to be resolved **Example** ```sh -apillon storage upload ./my_folder --bucket-uuid "123e4567-e89b-12d3-a456-426655440000" +apillon storage upload ./my_folder --bucket-uuid "123e4567-e89b-12d3-a456-426655440000" --wrap --path "main/subdir" ``` #### `storage get-file`