canonical: https://jentic.com/apis/aiodapp.com/aiodapp # Aiodapp AIOD Agent Discovery API The AIOD Agent Discovery API publishes versioned, unauthenticated metadata that lets an agent learn what AIOD can do before integrating. One operation returns a health document confirming the public discovery API is reachable, and the other returns AIOD's capability record: the address of its OAuth-protected automatic-discount server, the OAuth discovery documents, supported protocol revisions, tool documentation, safety limits, and links to its agent skills and plugin manifests. The discovery reads need no key, while the store-specific discount actions they point to are guarded by OAuth 2.1 with PKCE. Breaking REST changes move to a new major URL path so a stored integration stays stable. ## For AI agents Discover AIOD's agent capabilities and integration surface, and confirm the public discovery API is reachable, over two unauthenticated reads. Returns the discount server address, OAuth discovery documents, protocol revisions, and links to agent skills and plugin manifests. ## Scope Does not itself apply discounts, manage a storefront, or process orders. Use for discovering AIOD's agent capabilities and integration surface only. ## Capabilities - Discover AIOD's capability record: its automatic-discount server address, OAuth discovery documents, and supported protocol revisions - Read the links to AIOD's agent skills, plugin manifests, and RFC 9727 API catalog for integration - Check that AIOD's public discovery API is reachable before an agent relies on it ## Use cases ### Agent Discovery Before Integration An autonomous agent that wants to apply store discounts through AIOD first reads the capability record to learn where the OAuth-protected discount server lives, which protocol revisions it speaks, and what safety limits apply. Because the record carries the OAuth authorization and token URLs and links to agent skills and plugin manifests, the agent can wire the authorized integration from a single discovery call rather than hard-coding addresses. The discovery read is public, so this planning step needs no credential. Example prompt: Read AIOD's capability record and extract the discount server address, its OAuth authorization and token URLs, the supported protocol revisions, and the published safety limits. ### Health Checking a Dependency A client that depends on AIOD can call the health operation to verify the public discovery API is reachable before starting a run, and treat a non-ok response as a signal to defer or alert. The health document also carries canonical links to the documentation, the OpenAPI document, and the capability endpoint, so a monitor has everything it needs in one small response. This keeps integrations from failing deep in a workflow when the dependency is unavailable. Example prompt: Call the AIOD health operation, confirm the status is ok, and record the documentation and capability URLs it returns for later use. ### Mapping AIOD's Integration Surface A developer onboarding AIOD can read the capability record to enumerate every integration surface it advertises: the Agentic Resource Discovery manifest, the agent skills index, the agent plugin manifest, and the standard client manifest, each as a resolvable URL. This gives tooling and readiness scanners a single, versioned source of truth for how AIOD exposes itself to agents. Pointing at one discovery document avoids drift between hand-maintained integration notes. Example prompt: Read AIOD's capability record and list every advertised discovery resource, including the API catalog, the resource discovery manifest, the agent skills index, and the plugin manifest, as resolvable URLs. ## Key resources - **Health** — A small document confirming the public discovery API is reachable, with canonical documentation and capability links - **Agent Capabilities** — AIOD's capability record: discount server address, OAuth discovery documents, protocol revisions, safety limits, skills, and plugin manifests ## 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:** 82 / 100 - **Maturity:** AI-Ready - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 61 / 100 - AI-Readiness & Agent Experience: 81 / 100 - Agent Usability: 94 / 100 - Security: 90 / 100 - AI Discoverability: 81 / 100 - **View full report:** https://jentic.com/apis/aiodapp.com/aiodapp/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 ``` ## Why Jentic - **Setup:** Wiring the AIOD Agent Discovery API by hand means reading its public health and capability endpoints, then separately handling the OAuth 2.1 PKCE flow for the discount server it links to. Through Jentic you install once, import it from the API Directory, and your agent calls the discovery reads directly, with the OAuth authorization handled when you add the discount operations. - **Permission scoping:** The two discovery operations are read-only and need no key, so a rule can allow just the capability and health reads and nothing else. For the authorized discount actions on the linked server, you choose which operations your agent may call rather than handing it blanket access. - **Credential handling:** The public discovery reads need no credential at all. If you authorize AIOD's discount actions, that OAuth token is stored once, encrypted, by your own Jentic One instance and injected at execution time, never entering the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'discover AIOD capabilities' or 'check the AIOD API health', and Jentic returns the matching AIOD operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Shopify** — The commerce platform whose stores AIOD applies automatic discounts to - **Ecwid** — A different e-commerce platform with its own promotions, rather than AIOD's Shopify discount automation - **Magento** — A self-managed commerce platform with built-in cart price rules instead of a hosted discount agent ## FAQ ### What authentication does the AIOD Agent Discovery API use? Per its OpenAPI spec the two discovery operations, health and agent-capabilities, are unauthenticated public reads and need no key. The store-specific discount actions they point to live on a separate server guarded by OAuth 2.1 authorization-code flow with PKCE, scoped to reading, drafting, testing, and reporting on discounts for the authorized store. ### What can I discover with the AIOD Agent Discovery API? The capability record returns AIOD's product name and description, the address of its OAuth-protected discount server, the OAuth authorization and token URLs, supported protocol revisions, tool documentation, safety limits, and resolvable links to its agent skills index, plugin manifest, and RFC 9727 API catalog. It is the single document an agent reads to wire an AIOD integration. ### What are the rate limits for the AIOD Agent Discovery API? The OpenAPI spec does not publish rate limits for the AIOD Agent Discovery API; both endpoints are lightweight public reads intended for discovery. For current limits check the vendor documentation at https://www.aiodapp.com/developers/. ### How do I discover AIOD's capabilities through Jentic? Import the AIOD Agent Discovery API from the Jentic API Directory, then have your agent search by intent such as 'discover AIOD capabilities' and Jentic returns the agent-capabilities read with its input schema. The agent calls it and gets the discount server address and OAuth documents it needs to go further. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Can I limit what my agent is allowed to do with the AIOD Agent Discovery API? Yes. The two discovery operations are public reads, so a rule that allows only them lets your agent learn what AIOD can do and confirm it is reachable, without granting any discount write access. When you later authorize the discount server, you add only the discount operations the task needs, and every call it makes is logged. ### Is there an AIOD MCP server? Yes. AIOD runs an OAuth-protected MCP server for its discount actions, and this discovery API hands your agent its address along with the OAuth authorization and token URLs. You can also connect AIOD through Jentic: your credential is injected at call time by your self-hosted instance instead of living in a config file, your rules decide which operations the agent may call, and connecting the next API is an import rather than another install.