Rapport Power BI
pour Ticketing As A Service
Optimisez l'analyse de vos tickets avec notre rapport Power BI personnalisable !
With Ticketing API, you gain full control and flexibility to interact with Ticketing as a Service, extending its capabilities beyond its core functionality. Whether you want to automate ticket creation, extract ticket data for reporting purposes, or integrate ticketing features into your existing tools, Ticketing API empowers you to achieve your goals.
PRODUCTION BASE URL FOR CRM US (GLOBAL)
PRODUCTION BASE URL FOR CRM EU
Ticketing API follows REST industry-standard practices, using widely supported HTTP methods such as GET, POST, PUT, and DELETE.
AUTHENTICATION
To ensure secure authentication with our Ticketing as a Service REST API, we utilize an API key as an authentication query parameter. You have the option to use either the primary or secondary key for authentication purposes.
To access your API key, please follow these steps:
-
Navigate to the Ticketing App settings area.
-
Look for the API key section within the settings.
-
Genereate new keys. You will find both the primary (read/write) and secondary (ready only) keys listed.
Please note that the API key provided for authentication purposes in the setting area is valid only for a single ticketing instance.
When making API requests, include the API key as a query parameter in your requests. This will authenticate your requests and grant you access to the desired functionalities of Ticketing API.
Remember to handle your API keys with care and keep them secure. They provide access to your Ticketing as a Service account, and misuse or unauthorized access to the API keys can compromise the security of your system.
If you have any further questions or need assistance regarding API key authentication or any other aspect of our Ticketing as a Service API, please don't hesitate to reach out to our support team. We are here to help you integrate and leverage the power of our API seamlessly.
Please note that the API key provided for authentication in the settings area is valid only for a single CRM instance.
When making API requests, include the API key as a request header:
Ocp-Apim-Subscription-Key: YOUR_API_KEY
This will authenticate your requests and grant you access to the desired functionalities of CRM API.
Remember to handle your API keys with care and keep them secure. They provide access to your CRM as a Service account, and misuse or unauthorized access to the API keys can compromise the security of your system.
If you have any further questions or need assistance regarding API key authentication or any other aspect of our CRM as a Service API, please don't hesitate to reach out to our support team. We are here to help you integrate and leverage the power of our API seamlessly.
SANDBOX ENVIRONMENT
We recommend setting up your own sandbox or test environment. Having a dedicated test environment allows you to safely and securely test your integrations, functionality, and API calls without affecting your live or production environment.
ERRORS
CRM API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with CRM's servers. Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
PAGINATION
For some top-level API resources, CRM API provides pagination functionality to allow you to retrieve large datasets in a controlled and manageable manner. To implement pagination, we follow the conventional approach of using "page" and "size" parameters.
size: indicates the number of records to return to each page using the query parameter.
page: sets the page number. The default is 1, which shows the first page.
USER
See User in the Schema
A user is represented by an ID, name, and email. For users from your Microsoft 365 organization, it's important to ensure that this information remains consistent. Please note that the Ticketing API does not verify the consistency between the user's ID, name, and email.
If you require the ID, name, and email of a user, you can refer to the corresponding Object ID, Display Name, and Email attributes in Azure.
CUSTOM FIEDS
In the CRM, there are default pre-made forms available for Leads, Opportunities, Contacts, and Organizations. You can customize existing ones as needed.
-
For Leads and Opportunities, use the following endpoint: /pipeline/forms/opportunities
-
For Contacts, use: /directory/forms/contacts
-
For Organizations, use: /directory/forms/organizations
To retrieve the details of a form, make a GET request to the respective endpoint. The response will contain information such as field ID, field label, and tenant ID.
To update a form, use a PUT request to the appropriate endpoint.
BULK UPDATE AND RATE LIMITING
The CRM API supports bulk actions for performing bulk operations on leads, opportunities, contacts, and organizations. However, at this stage, only bulk deletion is available.