Developer Tools

TypeScript/JavaScript SDK for OAuth 2.0

Automate OAuth 2.0 workflows and streamline API integrations with the platform's developer-friendly SDK
What You'll Learn

This guide introduces the platform's TypeScript/JavaScript SDK—a powerful tool that automates OAuth 2.0 processes for developers building custom integrations.

You'll learn how the SDK simplifies token management, supports all public APIs, and integrates seamlessly with your existing development environment.

1

Key Benefits of the TypeScript/JavaScript SDK

The TypeScript/JavaScript SDK enhances your development workflow by providing automated, secure, and scalable authentication management. This developer-focused tool reduces complexity and allows you to concentrate on building innovative features.

Automated OAuth 2.0 Workflows — Fully automates OAuth 2.0 across all app installation scenarios, including automated installations and daily token refreshes.
Continuous API Connectivity — Automatically refreshes tokens to maintain uninterrupted access to platform APIs.
Flexible Database Integration — Features a database-agnostic design that integrates seamlessly with your preferred token management solution.
Complete API Support — Supports all public APIs with embedded sample code to accelerate implementation and reduce trial-and-error.
Always Up-to-Date — Evolves alongside API updates through fully automated SDK generation, ensuring alignment with new features.
Reduced Support Complexity — Abstracts complex OAuth 2.0 processes, minimizing common integration issues.
2

Automated OAuth 2.0 Management

The SDK abstracts the intricate OAuth 2.0 workflow, handling every step from app installation to token maintenance and uninstallation. This automation removes the burden of manual authentication management from your development process.

All Installation Scenarios — Manages all app installation types, including automated future installations.
Token Refresh Automation — Automatically refreshes tokens upon expiry to secure uninterrupted API access.
Streamlined De-Installation — Manages uninstallation workflows for enhanced security and cleanup.
3

Database-Agnostic Token Management

The SDK's flexible design allows you to integrate any database for token storage and management, ensuring seamless compatibility with your existing infrastructure. This approach gives you complete control over how and where authentication tokens are stored.

Flexible Database Integration — Connects effortlessly with your preferred database system.
Consistent Token Handling — Ensures reliable token management regardless of underlying storage technology.
Scalable Configuration — Offers customizable options to meet varied application requirements.
4

Integration with Public APIs and Embedded Samples

The SDK supports every public API endpoint, with practical code snippets embedded directly in the API documentation. This integration accelerates your implementation and reduces the learning curve for developers new to the platform's API ecosystem.

Complete API Coverage — Provides out-of-the-box integration with all public endpoints.
Ready-to-Use Code Samples — Features embedded sample code to reduce setup time and clarify usage.
Smoother Onboarding — Facilitates faster integration for developers new to the platform.
5

Automated SDK Generation

The SDK evolves alongside the platform's API offerings through fully automated generation. This ensures continuous alignment with new features and changes without requiring manual updates on your end.

Self-Updating SDK — Automatically regenerates to align with API modifications and enhancements.
Minimal Maintenance — Reduces the need for manual updates, keeping your development environment current.
Latest Improvements — Provides access to new API capabilities without additional developer effort.
Getting Started
Ready to Integrate the SDK?
Follow the setup steps below to start automating your OAuth 2.0 workflows
6

How to Set Up the TypeScript/JavaScript SDK

A streamlined setup process ensures you can quickly integrate automated OAuth 2.0 handling into your projects. Follow these steps to get started.

Step 1
Install the SDK via NPM

Run the following command in your terminal:

npm install @gohighlevel/api-client
Step 2
Import the SDK into Your Project

Add the following import statement to your TypeScript or JavaScript file:

import { HighLevelAPI } from '@gohighlevel/api-client';
Step 3
Configure OAuth 2.0 Credentials

Provide your app credentials and redirect URIs. Set the appropriate permissions that align with your application's requirements.

Step 4
Integrate Your Preferred Database

Connect your database to manage token storage, taking advantage of the SDK's flexible, database-agnostic design.

Step 5
Test Your Integration

Run a test API call using the sample code provided in the documentation to verify that token management and API connectivity work seamlessly.

Tip

For advanced configurations and troubleshooting guidance, consult the detailed documentation available in the dedicated SDK repository.

7

Frequently Asked Questions

Q: What processes does the SDK automate?
The SDK automates OAuth 2.0 workflows, including all installation scenarios, scheduled token refreshes upon expiry, and uninstallation procedures.
Q: How does the token refresh mechanism function?
The SDK automatically refreshes tokens upon expiry, ensuring continuous authentication without manual intervention. This maintains uninterrupted access to platform APIs.
Q: Can I use my existing database solution with this SDK?
Yes, the SDK's database-agnostic design allows you to integrate your preferred database for token management. This flexibility ensures compatibility with your existing infrastructure.
Q: Where can I find comprehensive documentation and sample projects?
Detailed documentation, including sample code and example projects, is available in the dedicated SDK repository and through the Getting Started with SDKs guide in the platform Marketplace documentation.
Q: Are additional SDKs for other programming languages planned?
Yes, SDKs for PHP and Python are planned for release, incorporating feedback from the developer community.
Q: How can I provide feedback or report issues?
You can share feedback or report issues through the platform's developer community channels or the SDK repository's issue tracker on GitHub.
Q: Is the SDK available on NPM?
Yes, the SDK is published on NPM as @gohighlevel/api-client for easy installation and integration into your projects.
Q: Does the SDK handle uninstallation scenarios?
Yes, the SDK manages uninstallation workflows to ensure proper cleanup and enhanced security when an app is removed.
8

Need Help?

If you encounter any issues or have questions about implementing the TypeScript/JavaScript SDK, our support team and developer community are here to assist you.

Developer Documentation — Access comprehensive guides, API references, and troubleshooting resources in the platform Marketplace documentation.
Community Support — Connect with other developers, share insights, and get answers through the developer community channels.
GitHub Repository — Review sample projects, report issues, and contribute to the SDK development on the official GitHub repository.
Technical Support — For platform-specific issues or integration challenges, reach out to the support team for personalized assistance.