Hello, how can we help you?

  1. Home page
  2. Return to search
  3. 05. Integrations
  4. API's
Movidesk API: What is it and how does it work?
5 min
Created by Maria Luiza Malheiro da Cunha on 7/22/2020 3:54 PM
Updated by Ligia Sarmento on 9/24/2024 4:04 PM
Tags: +API

The API (Application Programming Interface) is a set of rules and protocols that allow communication between different systems.

In the context of Movidesk, the API makes it possible for your system to connect to Movidesk to automate tasks and obtain data, using methods such as GET, POST and PATCH.

A real example would be a management system that uses the Movidesk API to consult the tickets received by support. When a customer opens a ticket in Movidesk, the API allows your company's internal system to consult these tickets automatically, bringing up information such as status, priority, description and date opened. This way, the support team can track and update tickets directly in their own system, without having to access Movidesk manually.

You can use our API to execute a series of actions automatically, such as:

    • Consult tickets: Use the GET method to retrieve data from one or more tickets.

    • Change tickets: The PATCH module allows you to make updates to tickets.

    • Enter new data: The POST method makes it possible to add information to the system.

In addition, you can create your own applications to consume our API, integrating it with your internal system and ensuring that the information is always up to date.

How to start using the Movidesk API?

In order to use the Movidesk API, you will need a key. authentication called Token, which is unique for each client. Follow the steps below to find it:

  1. Go to the Configuration menu.

  2. Vá até Account > Parameters.

  3. In the Environment tab, scroll to the bottom of the page to find the Token. Copy the key provided. 

With the authentication key in hand, choose a tool to test the API. At Movidesk, we recommend Postman, a widely used software to test and manipulate APIs with ease.

To test, follow the instructions:

    1. Open the Postman and create a new request.

    2. In the URL field, enter the API endpoint you want to consult. For example, to consult tickets, the endpoint would be https://api.movidesk.com/public/v1/tickets

    3. In the Authorization tab, select the authentication type as Bearer Token.

    4. Paste the key you copied earlier into the Token field.

    5. Choose the appropriate HTTP method (e.g. GET to query data).

    6. Click on Send to send the request à API. 

The API will return a response in JSON format containing the requested data, such as the list of tickets in the example. Check the fields returned to ensure that the integration is working correctly.

If the test is successful, you can integrate this process into your own system by using the token to automate API calls as required. required.

Tip: Visit this link and see all the existing APIs of the Movidesk. 

Administration of APIs in Movidesk

API administration involves managing how and when your integrations access the data.

Here are some important practices to ensure correct use:

  • Request limit: To maintain the stability of the system, we limit the use of the API to 10 requests per minute. This ensures a healthy use of resources and avoids overloading. If your use case requires a higher volume of requests, please contact our support for a personalized analysis.

  • Access control: The API token is the key to making API calls, so it is essential to keep it secure. We recommend that tokens are shared with caution and used only by authorized systems or developers.

  • Monitoring and Logs: Regularly monitor the use of your API requests, checking for errors or problems that may arise. Movidesk provides request logs that can help diagnose any failures or unexpected behavior.