Desk365’s API allows seamless integration with applications such as Asana, Jira, etc., providing enhanced functionality and streamlined processes. This guide will help you get started with the Desk365 API, covering everything from obtaining your API Key to understanding the latest updates in Version 2.
By following this guide, you will be able to effectively utilize the Desk365 API to improve your workflow and productivity.
Getting Started
To start using the Desk365 API, you first need to obtain an API Key. This key serves as the authorization token for all API requests.
- Obtain your API Key: Contact your Desk365 administrator or visit your Desk365 account settings to get your API Key.
2. Authorize: Click on the ‘Authorize’ button in the API interface and enter your API Key.
3. Access the Endpoints: Once authorized, you can access all the endpoints.
Please note that when using the API in your code, you should add the API Key in the “Authorization” header of your HTTP request.
Versioning with 'v2' in the Request URL
Desk365’s new version of the API enhances functionality, improves data consistency, and introduces new features. When accessing the new API endpoints, it is essential to include v2 in the ‘Request URL’ to ensure compatibility with the latest updates.
By using the v2 versioning in the URL, you ensure that your requests are directed to the latest version of the API, which includes the below improvements and any additional enhancements introduced in the future.
What's the difference?
- v1 URL (no change from initial URL):
- v2 URL (addition of v2 in the URL):
What's New in Version 2?
In Version 2, we have made significant updates to how our API handles empty fields and null values. Fields with null values will now be included in the API response, and fields that previously contained empty strings will be converted to null values. These changes enhance data consistency and clarity in our API responses.
1. Inclusion of Null Values
We have recently updated our API to improve how it handles empty fields. Previously, fields with null values were removed from the API response, and only fields with actual values were displayed. With the upcoming change, fields with null values will be included in the response, explicitly showing the fields with a “null” value.
Example of the Change
- Previous Response (when assigned to value is empty):
- New Response (with null values included):
2. Handling of Empty Strings
Fields that previously contained empty strings will now be converted to null values. This ensures consistency in how we represent missing or empty data across our API.
Example of the Change
Here is an example demonstrating the change:
- Previous Response with Empty Strings:
- New Response with Null Values:
By using null instead of an empty string, the API ensures that the absence of data is explicitly and consistently indicated.
Impact on Your Integration
- Inclusion of Null Values: You may need to update your code to handle the presence of null values in the response if your current implementation does not already account for this.
- Empty Strings to Null: Ensure that your application can properly handle fields that were previously empty strings now being represented as null.
Rate Limit Details
The Desk365 API has a rate limit in place to ensure fair usage and system stability. The current rate limit allows for 100 API calls per hour per API key.
By following this guide, you should be able to effectively utilize the Desk365 API to integrate with various applications, enhancing your workflow and productivity.
