Skip to content
Hot Local Business
Start onboarding

Developer SDK and OAuth

TypeScript and JavaScript SDK with OAuth 2.0.

Why it matters

Your developer can build integrations faster.

The HLB difference

Official SDK for the platform API.

How it works

Give your developer the SDK and OAuth tools to build integrations with HLB faster.

  • App developers can choose how people connect an app to outside services during install, using OAuth 2.0, API keys or basic authentication. Apps can support more than one connected account and ask for custom details at install.
  • In your marketplace app's external authentication settings, pick OAuth, API key or basic sign-in, add any install-time fields, and test the connection before you publish.

More ways for apps to connect to outside accounts

If you rely on a niche industry tool, it is now easier for a developer to build an app that connects it to your HLB account.

Developers building marketplace apps can connect to outside services with OAuth, API keys or a username and password. Apps can now let users link more than one outside account, ask for extra details at install time, show which account is connected, and use custom code for services with unusual sign-in steps.

See also App marketplace, Advanced API access and Custom integrations by the MDE dev team.

If you or a developer want to connect HLB to other software through its API, there are two tools: a TypeScript/JavaScript SDK that handles OAuth 2.0, and Private Integrations for simpler, scoped access to your account.

The SDK is a developer library that takes care of much of the OAuth 2.0 lifecycle: authorization during app installation, token storage, automatic token refresh and cleanup when an app is uninstalled. It is database-agnostic, so your developer connects whatever storage fits your setup, though storage is still required. It also provides generated services for supported public API endpoints, plus code samples.

Private Integrations let you give a developer or third-party app a token that only has the permissions you choose. Compared with older API keys, they are more secure and use the newer API version, which supports webhooks.

To create one:

  • Go to Settings and find Private Integrations under Other Settings.
  • Click Create new Integration and give it a name and description.
  • Select only the scopes the integration needs.
  • Copy the token right away (you cannot view it again) and share it only with trusted parties.

If Private Integrations is missing from Settings, enable the feature in Labs.

Private Integration tokens do not refresh on their own, and rotating them every 90 days is recommended. When you rotate, the old and new tokens both work for 7 days, and you can cancel the rotation or expire the old token sooner. If a token is compromised, rotate and expire it now. By default all account admins can create Private Integrations, and you can restrict this per user. To do this, edit the admin under Settings > My Staff, then Roles & Permissions.

Related features

Ready to put this to work in your business?

Start onboarding with the Max Digital Edge team and get set up on Hot Local Business.

Start onboarding