If you want to build your own integration on top of the Zocks API, you can create and manage your own app right inside Zocks. This article walks you through creating an app, configuring it, getting your credentials, and making it available to your users.
Before you start
Make sure that:
You are an Admin or Owner in your Zocks account.
You have access to Settings → Integrations → Apps → Create new app in Zocks. If you don't have access to this option, please reach out to your Home Office Enterprise Admin, who can enable it for you.
You have a server-side environment where you can securely store your client secret. It must never be exposed in client-side code.
You're familiar with OAuth 2.0. If you're new to it, start with the Zocks API documentation.
Create a new app
Go to Settings → Integrations → Apps and click Create new app. Setup takes three steps.
Step 1: Enter your app details
These details control what Zocks users see on the Apps page and when they authorize your app, so write them for that audience.
Logo URL (optional) - 256×256 px or larger, PNG or SVG, square ratio, max 512 KB.
App name - the name shown to users.
Short description - keep it short and clear; about 120 characters works best.
About - longer text shown in your app's About section.
What you can do - each line becomes a bullet point in the About section.
Step 2: Add redirect URIs
Add the redirect URI(s) Zocks should send users back to after they authorize your app. You can add more than one, and you can edit them later. Each URI must exactly match the redirect_uri your app sends during the OAuth flow.
Step 3: Choose your scopes
Select only the scopes your app needs. The available scopes are shown in the scope picker, grouped by the type of data they grant access to.
Get your credentials
When you finish setup, your app is created and you'll see your Client ID and Client Secret.
Manage your app
Your new app appears under Settings → Integrations → Apps, visible only within your own account. By default it's not enabled, so it won't be available for use until you turn it on.
To change your app's details, redirect URIs, or scopes, open the app and click Manage app.
Make your app available
How you turn on your app depends on where you want it used:
In your own account - When development is finished, enable the app and your users can start using it. No further steps needed.
Across an enterprise hierarchy - Email [email protected] to have your app enabled for an enterprise hierarchy.
For more details please check out the Developer Documentation.