{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aa1245fc-a2be-4dcb-9a14-5da48a23074d","name":"API Cxpress","description":"[Versão inglês (GB)](https://documenter.getpostman.com/view/45421173/2sB2x6msBP)\n\n[Versão Espanhol (latino neutro)](https://documenter.getpostman.com/view/45421173/2sB2x6mXha)\n\nBem-vindo à documentação da API de integração da Cxpress.\n\nEste documento apresenta a especificação técnica das requisições disponíveis para interação com a API, permitindo a realização de consultas e alterações a partir de aplicações externas. Também estão incluídas as instruções para geração do token de autenticação, essencial para garantir o acesso seguro aos endpoints. Este guia tem como objetivo fornecer todas as informações necessárias para o consumo eficiente, estruturado e confiável da API, viabilizando a integração com sistemas externos de forma segura e padronizada.\n\n### Estrutura\n\n1. A documentação está organizada por versões, com prioridade para a versão mais recente da API.\n \n2. Caso um determinado endpoint não esteja documentado na versão mais atual, deve-se utilizar o endpoint disponível na versão mais recente em que ela estiver documentada.\n \n3. A API da Cxpress possui limite de **300 requisições por minuto** por IP. Caso esse limite seja excedido dentro do período de 60 segundos, será aplicado automaticamente um **bloqueio de segurança de 10 minutos** para o IP responsável pelas requisições. \n \n\n# **Gerando uma entidade de integração**\n\nPara criar uma nova entidade de integração, o usuário com perfil de **PROPRIETÁRIO** da empresa deve seguir o caminho abaixo dentro da plataforma:\n\n**Menu lateral -> Configurações -> Empresa -> API**\n\n\n\nNa tela de API, clique no botão localizado no canto superior da interface:\n\n\n\nAo acionar esse botão, será exibido um modal onde deverão ser preenchidas as seguintes informações:\n\n- **Nome do token:** Nome de identificação da entidade de integração.\n \n- **Permissões:** Seleção dos endpoints que o token poderá acessar.\n \n\n\n\nApós a criação da entidade de integração, o `API Token` e o `Refresh Token` serão gerados e disponibilizados ao usuário. Esses tokens permitem autenticar requisições e realizar alterações na plataforma Cxpress por meio da integração com sistemas externos.\n\n**⚠️ Importante:** Os tokens são exibidos apenas uma vez após a criação. Certifique-se de armazená-los em local seguro.\n\n\n\n#### **Validade e Gerenciamento de Tokens**\n\n- O `API Token` possui validade de 1 hora. Após esse período, ele é automaticamente invalidado.\n \n- O `Refresh Token` tem validade de 168 horas (7 dias). Após sua expiração, não será mais possível gerar novos tokens de acesso a partir dele.\n \n\nO Token de Integração será exibido na listagem da interface, porém não poderá ser editado. Caso seja necessário alterar as permissões de acesso, o usuário deverá criar um novo token e definir as permissões desejadas no momento da criação.\n\n\n\nNa seção **Endpoints 1.0** deste documento, estão detalhadas as respostas de todos os endpoints acessíveis por meio de um Token de Integração, bem como as instruções para sua utilização.\n\n# **Configuração de Webhook**\n\nA funcionalidade de webhook permite que sistemas externos sejam notificados automaticamente sempre que determinados eventos ocorrerem na plataforma da Cxpress.\n\nNa tela de API, clique no botão localizado acima da listagem de Tokens:\n\n\n\n#### Campos de Configuração\n\nAo acionar esse botão, será exibido um modal onde deverão ser preenchidas as seguintes informações:\n\n- **Endpoint:** URL de destino para a qual as notificações de eventos serão encaminhadas. Trata-se do endereço configurado para recebimento das requisições HTTP geradas pelo mecanismo de webhook.\n \n- **Eventos:** Permite a seleção dos eventos que deverão acionar notificações para o endpoint configurado. É possível habilitar individualmente os seguintes tipos de eventos:\n \n - **Criação** (`create`) - Disparado quando uma das entidades disponíveis é criada na Cxpress.\n \n - **Atualização** (`update`) - Disparado quando uma das entidades disponíveis é modificada na Cxpress.\n \n\n\n\n#### Entidades Disponíveis\n\nAs notificações de webhook englobam os eventos ocorridos para os seguintes tipos de entidades:\n\n- **Consumidor**\n \n- **Ticket**\n \n- **Tarefa**\n \n- **Setor**\n \n- **Tags de Tickets**\n \n- **Tags de Consumidores**\n \n- **Campos Customizados**\n \n\n#### Funcionamento\n\nAo ativar um tipo de evento (Criação ou Atualização), o sistema enviará automaticamente uma notificação HTTP POST para o endpoint configurado sempre que a ação correspondente a uma entidade disponível ocorrer.\n\nO payload da requisição incluirá os dados atualizados ou recém-criados da entidade, permitindo que o sistema externo reaja em tempo real às mudanças.\n\n#### Exemplo de Caso de Uso\n\nAo habilitar o evento de criação (create), o endpoint configurado será acionado sempre que uma das entidades disponíveis for criada no sistema. A requisição enviada ao endpoint conterá, no corpo (payload), os dados da entidade recém-criada.\n\nPor exemplo, no caso do evento de criação da entidade Setor, o corpo da requisição será estruturado da seguinte forma:\n\n``` json\n{\n \"entity\": \"sector\",\n \"type\": \"create\",\n \"data\": {\n \"id\": \"4f36f4aa-78do-462d-bcoa-a74beb69452b\",\n \"company id\": \"G6cce6aBge-Oaeo-4e4c-Seac-e7d5ecaafaa7\",\n \"name\": \"Setor teste\",\n \"updated at\": \"2025-05-08T16:02:37.5692\",\n \"deleted at\": null,\n \"active\": true,\n \"created at\": \"2025-05-08T16:02:37.5692\",\n \"employees user ids\": [\n \"981c9949-2327-4fO0e-98d2-2a61f7ecbeaf\",\n \"feda355a-a75b-4a8a-b599-e2do2c23f983\"\n ], \n \"key words\": [\n \"esquerda\"\n ]\n }\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"45421173","collectionId":"aa1245fc-a2be-4dcb-9a14-5da48a23074d","publishedId":"2sB2qi8HcV","public":true,"publicUrl":"https://documenter-api.postman.tech/view/45421173/2sB2qi8HcV","privateUrl":"https://go.postman.co/documentation/45421173-aa1245fc-a2be-4dcb-9a14-5da48a23074d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/bf3074fa-f54d-4509-9883-4b4847698088/Q1hwcmVzcy1sb2dvLXdodC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"232960"}},{"name":"light","logo":"https://content.pstmn.io/dcba8083-fe3c-46be-93ca-b5397723410f/Q1hwcmVzcy1sb2dvICgyKS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"232960"}}]}},"version":"8.10.0","publishDate":"2025-06-03T21:31:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/dcba8083-fe3c-46be-93ca-b5397723410f/Q1hwcmVzcy1sb2dvICgyKS5wbmc=","logoDark":"https://content.pstmn.io/bf3074fa-f54d-4509-9883-4b4847698088/Q1hwcmVzcy1sb2dvLXdodC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB2qi8HcV"}