canonical: https://jentic.com/apis/zkcandyapi.com/zkcandyapi

# Zkcandyapi ZKcandy Gaming SDK API

ZKcandy Gaming SDK for building gaming experiences on ZKcandy's Ethereum Layer2 Hyperchain. Supports creating and managing NFT collections, minting NFTs, managing players, games, and wallets. The API exposes 8 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a new account, create a new nft collection. Covers 8 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Create a new account
- List all games
- Mint a new NFT
- Query and filter ZKcandy Gaming SDK API records by parameters
- Monitor ZKcandy Gaming SDK API operational status and events

## Use cases

### CRM Operations

Use the ZKcandy Gaming SDK API to perform crm operations programmatically. The API provides 8 endpoints covering core functionality including create a new account, create a new nft collection, create a new game.

Example prompt: Call POST /accounts to create a new account

### Automated Accounts Management

Automate accounts operations by combining multiple ZKcandy Gaming SDK API endpoints. Agents can create a new nft collection and then create a new game in a single workflow.

Example prompt: Call POST /collections to create a new nft collection, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ZKcandy Gaming SDK API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create a new account', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/accounts` | Create a new account |
| POST | `/collections` | Create a new NFT collection |
| POST | `/games` | Create a new game |
| GET | `/games` | List all games |
| POST | `/nfts/mint` | Mint a new NFT |
| POST | `/nfts/mint-sbt` | Mint a new Soulbound Token (SBT) |
| POST | `/players` | Create a new player |
| GET | `/players` | List all players |

## Key resources

- **Accounts** — Operations related to Accounts
- **Collections** — Operations related to Collections
- **Games** — Operations related to Games
- **NFTs** — Operations related to NFTs
- **Players** — Operations related to Players

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 58 / 100
- **View full report:** https://jentic.com/apis/zkcandyapi.com/zkcandyapi/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring ZKcandy by hand means setting its X-API-Key header on every call and shaping account, collection, game, and NFT payloads against the api.zkcandyapi.com host yourself. Through Jentic you install once, import the ZKcandy Gaming SDK from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** ZKcandy takes its targets in the request body rather than as owned path resources, so scoping is operations-only: limit the agent to the operations it needs, such as listing games or creating players. You choose the operations it may call, so state-changing ones like minting NFTs are not included unless you add them.
- **Credential handling:** Your ZKcandy API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a new account' or 'mint an NFT', and Jentic returns the matching ZKcandy operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the ZKcandy Gaming SDK API use?

The ZKcandy Gaming SDK API uses an API key passed in the `X-API-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create a new account with the ZKcandy Gaming SDK API?

Yes. Use the POST /accounts endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ZKcandy Gaming SDK API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create a new account through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new account'. Jentic returns the matching ZKcandy Gaming SDK API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ZKcandy Gaming SDK API have?

The ZKcandy Gaming SDK API exposes 8 endpoints covering accounts, collections, games operations.

### Can I limit what my agent is allowed to do with the ZKcandy Gaming SDK API?

Yes. Because you run Jentic One yourself, self-hosted, your own rules decide which ZKcandy operations and which stored API key the agent may use. Since ZKcandy takes its targets in the request body rather than as owned path resources, scoping is operations-only: you can allow read operations like listing games or players while withholding others. State-changing operations such as minting NFTs or creating accounts are not available to the agent unless you explicitly add them.