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.

User Sync prerequisites

Before you can use the User Sync endpoints, you must do the following things.

Enable User Sync

Contact AppDirect Support to enable User Sync for a product. Once enabled, the developer receives a subscription ID for their product. The subscription ID uniquely identifies the product in marketplace requests.

Obtain authentication credentials

To authenticate through the API, you need authentication credentials. To obtain credentials go to Manage > Billing and Distribution > Products > product name | Edit > Credentials. See Authorize inbound API requests (for separate credentials) or Authorize inbound API requests (legacy) (for shared credentials) for information on how to securely access product API requests.

note

The authentication credentials are for a product. Developer accounts are not associated with any particular product.

Was this page helpful?

Tell us more…

Help us improve our content. Responses are anonymous.

Thanks

We appreciate your feedback!

Enable User Sync
Obtain authentication credentials