Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/numbersprotocol/capture-sdk
https://github.com/numbersprotocol/capture-sdk
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/numbersprotocol/capture-sdk
- Owner: numbersprotocol
- License: gpl-3.0
- Created: 2023-02-06T10:52:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-15T09:10:18.000Z (over 1 year ago)
- Last Synced: 2023-09-16T00:13:37.973Z (over 1 year ago)
- Language: Shell
- Size: 42 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Capture SDK
The Capture SDK helps users use Numbers services easily and includes the utilities for [Numbers GitBook](https://docs.numbersprotocol.io/introduction/numbers-protocol).
## Nit API
The [Numbers official document](https://docs.numbersprotocol.io/) provides information on the scripts available for using the Nit API. The Nit API allows users to commit assets and retrieve asset commit information.
The following scripts are included in the [Getting Started](https://docs.numbersprotocol.io/developers/nit-git-for-media-files/getting-started#use-nit-api) tutorial for using the Nit API:
```sh
$ ./capture-api-get-token-by-email.sh
$ ./capture-api-verify-token.sh
$ cp .env.example .env
# update your Capture token in .env
# update your asset info in nit-api-commit.sh before running it
$ ./nit-api-commit.sh
$ ./nit-api-get-asset-commits.sh
```
Note: It is assumed that the reader has a basic understanding of shell scripts and API concepts. For detailed information on how to use each script, please refer to the official Nit API documentation.
## NSE API
The [Numbers Search Engine API document](https://docs.numbersprotocol.io/developers/search-engine-api) powered by AI technology, allows developers to easily locate and retrieve the exact match or similar assets/NFTs of their input content. The API returns the content information, marketplaces, and NFT history across supported blockchains, providing a comprehensive view of the digital asset.
```sh
# Discovering and retrieving digital assets that have been registered within
# the Web3 ecosystem. Additionally, a list of similar assets will be provided
# for further exploration.
$ ./nse-api-search-asset.sh
# Retrieving the NFT tokens that have been minted for a specific digital asset.
#
# The API takes the Nid of the asset as input and returns the cross-network NFT
# records for that asset.
$ ./nse-api-search-nft.sh
# The Theft Detection API is a powerful tool that helps you safeguard your
# digital assets by detecting any unauthorized use or duplication of your
# ontent.
#
# With this API, you can find similar assets and cross-network NFTs that
# use your asset, giving you the peace of mind that your creative work
# is protected.
$ ./nse-api-detect-theft.sh
```
## Check Capture Account Balance
Capture Account is an essential tool for Capture App users and developers using the Numbers Protocol. When the account is created, two wallets, one for managing Web3 assets and one for signing the Capture photos are automatically generated for the user. This eliminates the need for users to manually create and manage multiple wallets, saving valuable time and resources.
For the details, please refer to [Capture Account and Wallet](https://docs.captureapp.xyz/about-capture/capture-account-and-wallet).
```sh
# To check Capture Account balance, please see the example below.
#
# When calling an API, the costing rule is
# * If Capture Credits (points) is sufficient, costs from Credits.
# * Else if Asset Wallet balance is sufficient, cost from Asset Wallet.
$ ././capture-api-show-num-balance.sh
```
## Send A Pull Request
1. Supporter creates a branch with the naming `feature-` or `fix-`.
2. Supporter sends a PR to `main`.