Uma requisição POST em API é usada para enviar dados ao servidor, geralmente para criar um novo recurso ou realizar uma ação específica, enviando informações no corpo da requisição.
Com requisições do tipo "POST", você poderá criar clientes, abrir tickets, criar campos personalizados e opções de campos personalizados, entre outros.
Neste exemplo prático, estaremos criando um ticket no Tiflux.
Para abrir um ticket, iremos consumir a rota de Criar ticket.
Para criar um ticket via API, é necessário fornecer alguns parâmetros, sendo alguns obrigatórios e outros opcionais. Para consultar a lista completa desses parâmetros, clique aqui.
Segue um exemplo da requisição sendo efetuada através do Postman:
No caso do exemplo acima, eu passei tanto parâmetros obrigatórios como parâmetros opcionais.
Neste caso, o retorno será da seguinte forma:
{"ticket": {"ticket_number":4442,"client": {"id":1271773,"name":"Novo Guia de Uso","social":"Novo Guia de Uso","social_revenue":"23528323000158","status":true },"closed_ticket_total_spent_solving":null,"created_at":"2024-11-12T14:24:25Z","created_by_id":963604,"created_by_way_of":"Tiflux API","created_with_ai":false,"custom_fields":null,"description":"Aberto via API v2","desk": {"id":46370,"active":true,"appointment_type":"Without Appointments","display_name":"Triagem","name":"Triagem" },"equipment": {"id":null,"name":null,"group_id":null,"user_id":null },"feedback":null,"followers":null,"is_closed":false,"is_duplicating":false,"is_grouped":false,"is_revised":false,"last_answer_type":null,"last_reopen_date":null,"priority": {"id":146872,"end_time":"60:00","name":"Low","order":2,"start_time":"06:00" },"priority_change_reason":null,"reopen_count":0,"requestor": {"id":2965212,"email":"tifluxsuporte@outlook.com","name":"Novo Guia de Uso","ramal":null,"telephone":"+4829364596" },"responsible":null,"services_catalog":null,"sla_info": {"attend_expiration":null,"attend_sla":null,"attend_sla_solution":null,"desactivate_sla_reason":null,"solve_expiration":null,"solved_in_time":null,"stage_expiration":"2024-11-12T16:54:00Z","stopped":false },"stage": {"id":277203,"first_stage":true,"last_stage":false,"max_time":"01:00","name":"Pending" },"status": {"id":149730,"default_canceled":false,"default_close":false,"default_open":true,"name":"Opened" },"ticket_children": [],"ticket_reference": {},"title":"Aberto via API v2","updated_at":"2024-11-12T14:24:25Z","updated_by_id":963604,"worked_hours":"00:00" }}
O retorno consiste em mostrar todos os campos preenchidos ou não na abertura do ticket.
Para obter detalhes sobre cada rota de inserção de dados, incluindo os parâmetros necessários e os respectivos retornos, consulte a documentação oficial da API.
