OAuth 2.0 Setup & Authentication Guide OAuth 2.0 Setup & Authentication Guide

OAuth 2.0 Setup & Authentication Guide

Charlotte Charlotte

Overview

To programmatically access Zensoft customer data, your application must authenticate using the OAuth 2.0 protocol. This guide provides the necessary endpoints and steps to generate a valid access token.

Step 1: Create an App in the Zensoft Developer Portal

Before requesting a token, you must register your application to receive a Client ID and Client Secret.

  1. Log in to the Zensoft Developer Dashboard.

  2. Click Create New App.

  3. Set your Redirect URI to https://your-app.com/callback.

  4. Save the generated credentials securely.

Step 2: Authorization Request

Direct your users to the following Zensoft endpoint to authorize your application: GET https://api.zensoft.com/v2/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID

Step 3: Exchange Code for Access Token

Once the user authorizes the app, exchange the authorization code for an access token using this request:

POST /v2/oauth/token Host: api.zensoft.com Body:

  • grant_type: authorization_code

  • code: [AUTHORIZATION_CODE]

  • client_id: [YOUR_CLIENT_ID]

  • client_secret: [YOUR_CLIENT_SECRET]


Quick Setup Checklist

  • [ ] Verify Client ID is active.

  • [ ] Ensure Redirect URIs match exactly.

  • [ ] Check that your scopes include read:tickets and write:tickets.


Configuration Reminder

Once you have pasted this into your Knowledge base:

  1. Section: Assign this to a section like "API Documentation."

  2. Visibility: Set to Visible to everyone (Public).

  3. Publish: Hit Publish so the procedure editor can find it.

Was this article helpful?

0 out of 0 found this helpful

Add comment

Please sign in to leave a comment.