Skip to main content

Developer Portal

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.

Product

Overview

Use the Product GraphQL APIs to create, update, and download products, including product shells, editions, and pricing plans. These APIs can also help you bulk-create, update, and download products in the staging catalog.

Important

This feature is currently in Early Availability (EA) status. For more information, see GraphQL API policy.

Prerequisites

Before you can get started with the various APIs for some of these tasks, you must ensure that the following prerequisites are in place.

Select the appropriate grant types and scopes for your use case. See Grant types and Scopes.
Create an API client to use with the AppDirect API. See API clients.
Authenticate your client. See API Authentication.
Test your API calls with your access token using a third-party API IDE, for example Postman.

Working with Product APIs

Use our Hosted GraphQL Explorer to test your queries and mutations.
Manage products, including product branding, edition branding and pricing information.
Manage product integrations for different events (create, upgrade, and cancel).

API Reference

GraphQL API

Was this page helpful?

Tell us more…

Help us improve our content. Responses are anonymous.

Thanks

We appreciate your feedback!

Overview
Prerequisites
Working with Product APIs
API Reference