{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-getting-started/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Step 1. Create a developer account & app","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-a-developer-account--app","__idx":0},"children":["Step 1. Create a developer account & app"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prerequisites"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A company email address"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Permission to create apps for your organization"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Steps"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sign up / sign in at ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Developer Portal"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[sign in URL]"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["My Apps → Create App"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fill in:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["App name"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact email"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tip:"]}," Use a separate app per environment (e.g., ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["MyApp-PIE"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["MyApp-Prod"]},") for distinction between testing and use cases."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-get-your-client-id-secret-then-choose-your-api-for-your-use-case","__idx":1},"children":["Step 2. Get your Client ID, Secret then Choose your API for your use case."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After creation, your app will display a combination of 32-character hexadecimal string, often formatted as five groups of numbers and letters separated by hyphens"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]},": Public identifier for your developer app"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client Secret"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(keep confidential)"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Select API Products"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open your app page → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Selected API"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explore our API Catalogue Page and select the APIs you'd like to call (e.g., ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Class Partner API"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["DMS"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Save changes."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Partner Integration Environment (PIE)"]},": Sandbox for testing and building your integration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]},": Real data that currently sits within Production environment within Class"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-understand-your-oauth-20-implementation-partner-vs-client","__idx":2},"children":["Step 3. Understand your OAuth 2.0 implementation (Partner vs Client)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Most integrations use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OAuth 2.0"]}," to obtain access tokens. Choose the grant type that matches your use case:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"a-client-single-tenant","__idx":3},"children":["A. Client (single-tenant)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your organization accesses your own data that sits within Class."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Common grant types:"]}," Resource Owner Password Flow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tokens:"]}," Scoped to your organization/resources"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"b-partner-multi-tenant","__idx":4},"children":["B. Partner (multi-tenant)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You are a Partner application where users on Class have to authorise Partner application to have access to their scoped data. (Authorization Code Flow Implemetation)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consent per customer/tenant"]}," (Prompt user to authorise)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Token storage per tenant"]}," (Securely map and store tokens on your application customer)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Callback/Redirect URL"]}," (Please email us your Redirect URL at Partners@class.com.au)"]}]}]},"headings":[{"value":"Step 1. Create a developer account & app","id":"step-1-create-a-developer-account--app","depth":2},{"value":"Step 2. Get your Client ID, Secret then Choose your API for your use case.","id":"step-2-get-your-client-id-secret-then-choose-your-api-for-your-use-case","depth":2},{"value":"Step 3. Understand your OAuth 2.0 implementation (Partner vs Client)","id":"step-3-understand-your-oauth-20-implementation-partner-vs-client","depth":2},{"value":"A. Client (single-tenant)","id":"a-client-single-tenant","depth":3},{"value":"B. Partner (multi-tenant)","id":"b-partner-multi-tenant","depth":3}],"frontmatter":{"seo":{"title":"Step 1. Create a developer account & app"}},"lastModified":"2026-06-20T12:17:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/getting-started/create-app","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}