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.

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.

GraphQL Changelog

Review upcoming and previous GraphQL schema updates, including GA and Preview changes, deprecations, and retirements.

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

LLMs.txt

Provides LLM-friendly documentation to help AI tools like Cursor understand and work with the AppDirect Developer Portal content.

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.

Company Sync prerequisites

Complete the following before using the Company Sync endpoints.

Enable Company Sync

To enable Company Sync, contact your AppDirect technical representative.

Obtain authentication credentials

To authenticate with 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)

note

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

Endpoint URLs

Send notifications to these endpoints:

To create a new Developer Account: /api/sync/v1/tasks
To set a Developer Account to expired: /api/sync/v1/tasks

Both endpoints accept a list of developer account details in the JSON payload.

Was this page helpful?

Tell us more…

Help us improve our content. Responses are anonymous.

Thanks

We appreciate your feedback!

Enable Company Sync
Obtain authentication credentials
Endpoint URLs