{"info":{"_postman_id":"5b47fe37-c7c0-4a16-85e9-030c69e03f81","name":"Recuperar Dados de Atendimentos e de Clientes no Citrus v1.0.0","description":"

Visão Geral

\n
\n

Esta API foi desenvolvida no Cloud Ticket para Recuperar Dados de Atendimentos e de Clientes no Citrus.

\n

IMPORTANTE: Em caso de substituição da empresa que consome a API é indispensável entrar em contato com a Smartspace para obtenção de uma nova chave de acesso.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39004890","collectionId":"5b47fe37-c7c0-4a16-85e9-030c69e03f81","publishedId":"2sAXxV7Abh","public":true,"customColor":{"top-bar":"C8DF00","right-sidebar":"303030","highlight":"C8DF00"},"publishDate":"2025-08-01T13:04:59.000Z"},"item":[{"name":"Pré-requisitos e Permissões","item":[],"id":"3194b027-f950-4538-b55d-ae4facb5cd4a","description":"

Apenas usuário com chave válida e ativa pode acessar a API através do header X-API-KEY.

\n

Para obter a chave entrar em contato com a equipe de implantação Smartspace by Digivox.

\n","_postman_id":"3194b027-f950-4538-b55d-ae4facb5cd4a"},{"name":"Acesso","item":[],"id":"bde97189-5dbb-4a6e-aa86-0146c6b4705a","description":"

O path para fazer requisições usando a API Citrus Cloud Ticket é o URL customizado da empresa no Cloud Tickect (URL Base), somado à /api/ no final do endereço.

\n

Exemplo: https://urlbase/api/v1/clients/ticket-range-date?startDate&endDate \n 

\n

Onde:

\n

URL base= endereço do ambiente de produção do cliente no Cloud Ticket.

\n

startDate= Data Inicial do intervalo a ser consultado.

\n

endDate= Data final do intervalo a ser consultado.

\n

IMPORTANTE:

\n\n","_postman_id":"bde97189-5dbb-4a6e-aa86-0146c6b4705a"},{"name":"Recuperar informações de clientes e dados de atendimento","item":[],"id":"e16ccc25-bf8b-438d-9ec8-f2572ff15373","description":"

Este endpoint permite recuperar informações detalhadas sobre atendimentos (tickets) de clientes, no período informado.

\n","_postman_id":"e16ccc25-bf8b-438d-9ec8-f2572ff15373"},{"name":"Buscar atendimentos dentro de um intervalo de datas","id":"96ac8290-52ba-486f-aae8-5dc3a8d5a301","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://urlbase/api/v1/clients/ticket-range-date?startDate&endDate","description":"

Para consultar os atendimentos realizados em um intervalo de datas determinado, chame

\n

GET https://urlbase/api/v1/clients/ticket-range-date?startDate&endDate.

\n

A consulta considera como parâmetro obrigatório um intervalo de datas: (startDate & endDate), no formato dd/mm/yyyy. Além da chave de acesso válida e ativa. \n 

\n

Respostas

\n

Feita a requisição, podem ser apresentadas as seguintes possibilidades de respostas: \n 

\n

Exemplo de chamada de sucesso

\n

A resposta do código 200 indica que a consulta foi realizada com sucesso e o sistema retornará um JSON com a lista de atendimentos realizados no período pesquisado.

\n

Exemplo:

\n
{ \n\"200 OK\" \n} \n\n
\n

Exemplos de falha na chamada

\n

Caso os dados informados estejam incorretos ou aconteça alguma falha na abertura da chamada, a API poderá retornar: \n 

\n

código 400 e um JSON indicando Bad Request.

\n

Exemplo: Erro na Data de Início ou Data Final.

\n
{ \n\"400 Bad Request\"\n} \n\n
\n

código 401 e um JSON indicando Chave Inválida ou Inexistente.

\n

Exemplo: A chave informada está incorreta ou não foi informada a chave.

\n
{ \n\"401 Bad Request\"\n} \n\n
\n

código 404 e um JSON indicando Not Found.

\n

Exemplo: Nenhum dado encontrado.

\n
{ \n\"404 Not Found\"\n} \n\n
\n","urlObject":{"protocol":"https","path":["api","v1","clients","ticket-range-date"],"host":["urlbase"],"query":[{"key":"startDate","value":null},{"key":"endDate","value":null}],"variable":[]}},"response":[{"id":"b130ca04-dc98-4c47-b635-5bbb183f2679","name":"200-OK","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"https://urlbase/api/v1/clients/ticket-range-date?startDate=01/09/2024&endDate=19/09/2024","protocol":"https","host":["urlbase"],"path":["api","v1","clients","ticket-range-date"],"query":[{"key":"startDate","value":"01/09/2024"},{"key":"endDate","value":"19/09/2024"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"id\t[...]\nname\t[...]\ncode\t[...]\nclientType\tClientTypeRangeDTO{...}Jump to definition\nphone\t[...]\ncellphone\t[...]\nemail\t[...]\ntickets\t[...]\n \n}]"},{"id":"0b2ead6a-e791-4e22-90a1-1f69b15d205f","name":"400-Bad Request","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"}],"url":{"raw":"https://urlbase/api/v1/clients/ticket-range-date?startDate=01/09/24&endDate=19/09/2024","protocol":"https","host":["urlbase"],"path":["api","v1","clients","ticket-range-date"],"query":[{"key":"startDate","value":"01/09/24"},{"key":"endDate","value":"19/09/2024"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"clientType\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"code\": \"string\"\n },\n \"phone\": \"string\",\n \"cellphone\": \"string\",\n \"email\": \"string\",\n \"tickets\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"protocol\": \"string\",\n \"status\": \"string\",\n \"visible\": true,\n \"opening\": \"2024-10-18T13:36:48.860Z\",\n \"startOpening\": \"2024-10-18T13:36:48.860Z\",\n \"description\": \"string\",\n \"ocurrency\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"ocurrencyType\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"description\": \"string\"\n }\n },\n \"creator\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"username\": \"string\",\n \"phone\": \"string\",\n \"email\": \"string\"\n },\n \"clientId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"extraFields\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"label\": \"string\"\n }\n ]\n }\n ]\n }\n]"},{"id":"85636054-5c83-4002-b866-01f82571de42","name":"401-Chave de API inválida ou Ausente","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"}],"url":{"raw":"https://urlbase/api/v1/clients/ticket-range-date?startDate=01/09/2024&endDate=19/09/2024","protocol":"https","host":["urlbase"],"path":["api","v1","clients","ticket-range-date"],"query":[{"key":"startDate","value":"01/09/2024"},{"key":"endDate","value":"19/09/2024"}]}},"status":"401- Chave Inválida/Ausente","_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b0e8c9d5-9375-4e95-a2e7-232bb06da946","name":"404- Not Found","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"}],"url":{"raw":"https://urlbase/uniftc/api/v1/clients/ticket-range-dat","protocol":"https","host":["urlbase"],"path":["uniftc","api","v1","clients","ticket-range-dat"],"query":[{"key":"startDate","value":"","disabled":true},{"key":"endDate","value":"","disabled":true}]}},"status":"404-Not Found","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\r\n404 Not Found\r\n\r\n

404 Not Found

\r\n
nginx
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n"}],"_postman_id":"96ac8290-52ba-486f-aae8-5dc3a8d5a301"}],"variable":[{"key":"baseUrl","value":"URL base"}]}