User Guides

Billing and Subscriptions

Manage subscriptions, payment method information and discounts using REST APIs.

Products

Manage products in the catalog by defining product information, editions and pricing plans using GraphQL APIs.

Users and Accounts

Manage users, companies, and memberships in your marketplace including user roles and permissions.

API Authentication

Our APIs use an OAuth-authenticated interface that facilitates secure data access by partners and developers.

AI User Guides

Get started building AIs for yourself, your organization, or your customers. Craft profiles, configure data sources, and model parameters.

APIs and References

GraphQL API Reference

Explore the reference documentation to learn more about the queries and mutations currently available within the AppDirect GraphQL API.

REST API Reference

See examples of how to perform different tasks, like user and company management or billing and subscription management.

AI APIs

Customize, integrate, and extend AIs for your organization and customers via industry-standard APIs

Developer Tools

GraphQL Explorer

Quickly write, validate, and test GraphQL queries for AppDirect APIs

GraphQL Schema Introspection

Query the schema to discover available queries, mutations, subscriptions, types and fields in our GraphQL API.

Demo GraphQL API Explorer

Check out the demo explorer tool by running queries using sample data.

Storefront Theming

Getting Started

Learn to modify elements of Plaza, our default theme, to customise components for storefront display including homepage and product profiles.

How to Guides

Everything you need to know about customizing styles, meta tags, creating a header and footer, or localising, uploading and publishing your theme.

Storefront Toolkit

Check out the demo explorer tool by running queries using sample data.

Getting started

Use the following resources to learn more about how to get started with Product APIs and use them to create and manage products in your marketplace:

Product data model: Learn more about how products are defined by their own attributes, assets, pricing, and integration.
Understanding product publication: Understand the role of publication in producing marketplace-ready products.
Understanding Product APIs: Marketplace vs. Catalog: Learn about the differences and use cases for Marketplace Product APIs and Product (catalog) APIs.
API guide: Learn the Product API basics, the workflow of product creation and management, and how to troubleshoot common issues.

note

Application is a legacy term for a product and is still present in some documentation. Product is the preferred term.

Help us improve our content. Responses are anonymous.

Thanks

We appreciate your feedback!