/ Integração via API

Ondesk

O Ondesk possui uma API REST para interagir com suas principais funções. Cada requisição possui uma URL e a resposta é no formato JSON.

Autenticação

Em todas as requisições é necessário informar no cabeçalho os parâmetros "Código" (código de cliente) e "Chave" (chave de integração). Essas informações estão disponíveis nos parâmetros do sistema quando a interação com a API é ativada.

As solicitações devem ser feitas para o endereço https://www.ondesk.com.br/api/ e nas requisições do tipo PUT e POST também é necessário informar o tipo de dados JSON no cabeçalho.

Exemplo com Fiddler

Para facilitar a integração, indicamos o programa Fiddler (www.telerik.com/fiddler). Com as informações "Código" e "Chave" é possível realizar as chamadas de testes utilizando o Fiddler para visualizar os resultados.

Projeto de Exemplo

Disponibilizamos também, um projeto de exemplo (www.ondesk.com.br/integracao) para que você possa realizar alguns testes utilizando a sua conta e efetuar o download.

Clientes Chamados Estrutura

GET clientes/listar

Parâmetros

Parâmetro Tipo Valor Padrão Descrição
PaginaOpcional Inteiro 1 Página da listagem de registros.
RegistrosOpcional Inteiro 20 Número de registros por página (Máximo é 100).
OrdemOpcional Texto "Codigo" Ordem dos registros (Codigo, Nome ou Email).
CrescenteOpcional Inteiro 1 Tipo da ordenação do campo de ordem (0 ou 1).
BuscaOpcional Texto Texto para buscar o cliente por cliente ou e-mail.

Informações não disponíveis para a resolução deste dispositivo.

Resposta

  1. [
  2.   {
  3.     "Codigo": 100000,
  4.     "Interno": 1,
  5.     "Nome": "Lac Sistemas LTDA",
  6.     "Email": "suporte@lacsistemas.com.br",
  7.     "Grupo": "",
  8.     "Situacao": "A"
  9.   },
  10.   {
  11.     "Codigo": 100001,
  12.     "Interno": 2,
  13.     "Nome": "Smart Publicidade LTDA",
  14.     "Email": "contato@smartpublicidade.com.br",
  15.     "Grupo": "",
  16.     "Situacao": "A"
  17.   }
  18. ]

Informações não disponíveis para a resolução deste dispositivo.

GET clientes/selecionar

Parâmetros

Parâmetro Tipo Descrição
Codigo Inteiro Código de identificação do cliente.

Informações não disponíveis para a resolução deste dispositivo.

Resposta

  1. {
  2.   "Codigo": 100000,
  3.   "Interno": 1,
  4.   "Nome": "Lac Sistemas LTDA",
  5.   "Fantasia": "Lac Sistemas",
  6.   "Email": "suporte@lacsistemas.com.br",
  7.   "Grupo": "",
  8.   "Situacao": "A",
  9.   "Endereco": "Rua General Costa Campos",
  10.   "Numero": "65",
  11.   "Complemento": "Sala 301",
  12.   "Bairro": "Centro",
  13.   "Cidade": "Alfenas",
  14.   "Estado": "MG",
  15.   "Cep": "37130-000",
  16.   "Telefone1": "(35) 3292-8398",
  17.   "Telefone2": "",
  18.   "Pessoa": "J",
  19.   "Documento": "04.856.207/0001-13",
  20.   "Cadastro": "10/06/2014 13:05:30",
  21.   "Usuarios":
  22.   [
  23.     {
  24.       "Codigo": 100000,
  25.       "Nome": "João de Barro",
  26.       "Login": "joao@ondesk.com.br",
  27.       "Apelido": "João",
  28.       "Telefone1": "(35) 3292-8398",
  29.       "Telefone2": "",
  30.       "Administrador": 1,
  31.       "Pagamentos": 1,
  32.       "Cadastro": "10/06/2014 13:05:31"
  33.     },
  34.     {
  35.       "Codigo": 100001,
  36.       "Nome": "Maria da Silva",
  37.       "Login": "maria@ondesk.com.br",
  38.       "Apelido": "Maria",
  39.       "Telefone1": "(35) 3292-8398",
  40.       "Telefone2": "",
  41.       "Administrador": 0,
  42.       "Pagamentos": 0,
  43.       "Cadastro": "10/06/2014 13:05:32"
  44.     }
  45.   ]
  46. }

Informações não disponíveis para a resolução deste dispositivo.

PUT clientes/adicionar

Dados

Exemplo 01 Exemplo 02 Exemplo 03
  1. {
  2.   "Nome": "Lac Sistemas LTDA",
  3.   "Email": "suporte@lacsistemas.com.br"
  4. }
  1. {
  2.   "Nome": "Lac Sistemas LTDA",
  3.   "Email": "suporte@lacsistemas.com.br",
  4.   "Usuarios":
  5.   [
  6.     {
  7.       "Nome": "João de Barro",
  8.       "Login": "joao@ondesk.com.br"
  9.     },
  10.     {
  11.       "Nome": "Maria da Silva",
  12.       "Login": "maria@ondesk.com.br"
  13.     }
  14.   ]
  15. }
  1. {
  2.   "Interno": 1,
  3.   "Nome": "Lac Sistemas LTDA",
  4.   "Fantasia": "Lac Sistemas",
  5.   "Email": "suporte@lacsistemas.com.br",
  6.   "Grupo": "",
  7.   "Situacao": "A",
  8.   "Endereco": "Rua General Costa Campos",
  9.   "Numero": "65",
  10.   "Complemento": "Sala 301",
  11.   "Bairro": "Centro",
  12.   "Cidade": "Alfenas",
  13.   "Estado": "MG",
  14.   "Cep": "37130-000",
  15.   "Telefone1": "(35) 3292-8398",
  16.   "Telefone2": "",
  17.   "Pessoa": "J",
  18.   "Documento": "04.856.207/0001-13",
  19.   "Usuarios":
  20.   [
  21.     {
  22.       "Nome": "João de Barro",
  23.       "Login": "joao@ondesk.com.br",
  24.       "Apelido": "João",
  25.       "Telefone1": "(35) 3292-8398",
  26.       "Telefone2": "",
  27.       "Administrador": 1,
  28.       "Pagamentos": 1,
  29.       "Situacao": "A"
  30.     },
  31.     {
  32.       "Nome": "Maria da Silva",
  33.       "Login": "maria@ondesk.com.br",
  34.       "Apelido": "Maria",
  35.       "Telefone1": "(35) 3292-8398",
  36.       "Telefone2": "",
  37.       "Administrador": 0,
  38.       "Pagamentos": 0,
  39.       "Situacao": "A"
  40.     }
  41.   ]
  42. }

Informações não disponíveis para a resolução deste dispositivo.

Resposta

  1. {
  2.   "Codigo": 0,
  3.   "Descricao": "A operação foi executada com sucesso.",
  4.   "Objeto":
  5.   {
  6.     "Codigo": 100000,
  7.     "Interno": 1,
  8.     "Nome": "Lac Sistemas LTDA",
  9.     "Fantasia": "Lac Sistemas",
  10.     "Email": "suporte@lacsistemas.com.br",
  11.     "Grupo": "",
  12.     "Situacao": "A",
  13.     "Endereco": "Rua General Costa Campos",
  14.     "Numero": "65",
  15.     "Complemento": "Sala 301",
  16.     "Bairro": "Centro",
  17.     "Cidade": "Alfenas",
  18.     "Estado": "MG",
  19.     "Cep": "37130-000",
  20.     "Telefone1": "(35) 3292-8398",
  21.     "Telefone2": "",
  22.     "Pessoa": "J",
  23.     "Documento": "04.856.207/0001-13",
  24.     "Cadastro": "10/06/2014 13:05:30",
  25.     "Usuarios":
  26.     [
  27.       {
  28.         "Codigo": 100000,
  29.         "Nome": "João de Barro",
  30.         "Login": "joao@ondesk.com.br",
  31.         "Apelido": "João",
  32.         "Telefone1": "(35) 3292-8398",
  33.         "Telefone2": "",
  34.         "Administrador": 1,
  35.         "Pagamentos": 1,
  36.         "Cadastro": "10/06/2014 13:05:31"
  37.       },
  38.       {
  39.         "Codigo": 100001,
  40.         "Nome": "Maria da Silva",
  41.         "Login": "maria@ondesk.com.br",
  42.         "Apelido": "Maria",
  43.         "Telefone1": "(35) 3292-8398",
  44.         "Telefone2": "",
  45.         "Administrador": 0,
  46.         "Pagamentos": 0,
  47.         "Cadastro": "10/06/2014 13:05:32"
  48.       }
  49.     ]
  50.   }
  51. }

Informações não disponíveis para a resolução deste dispositivo.

POST clientes/atualizar

Parâmetros

Parâmetro Tipo Descrição
Codigo Inteiro Código de identificação do cliente.

Informações não disponíveis para a resolução deste dispositivo.

Dados

Exemplo 01 Exemplo 02 Exemplo 03
  1. {
  2.   "Nome": "Lac Sistemas LTDA",
  3.   "Email": "suporte@lacsistemas.com.br",
  4. }
  1. {
  2.   "Nome": "Lac Sistemas LTDA",
  3.   "Email": "suporte@lacsistemas.com.br",
  4.   "Usuarios":
  5.   [
  6.     {
  7.       "Nome": "João de Barro",
  8.       "Login": "joao@ondesk.com.br"
  9.     },
  10.     {
  11.       "Nome": "Maria da Silva",
  12.       "Login": "maria@ondesk.com.br"
  13.     }
  14.   ]
  15. }
  1. {
  2.   "Interno": 1,
  3.   "Nome": "Lac Sistemas LTDA",
  4.   "Fantasia": "Lac Sistemas",
  5.   "Email": "suporte@lacsistemas.com.br",
  6.   "Grupo": "",
  7.   "Situacao": "A",
  8.   "Endereco": "Rua General Costa Campos",
  9.   "Numero": "65",
  10.   "Complemento": "Sala 301",
  11.   "Bairro": "Centro",
  12.   "Cidade": "Alfenas",
  13.   "Estado": "MG",
  14.   "Cep": "37130-000",
  15.   "Telefone1": "(35) 3292-8398",
  16.   "Telefone2": "",
  17.   "Pessoa": "J",
  18.   "Documento": "04.856.207/0001-13",
  19.   "Usuarios":
  20.   [
  21.     {
  22.       "Nome": "João de Barro",
  23.       "Login": "joao@ondesk.com.br",
  24.       "Apelido": "João",
  25.       "Telefone1": "(35) 3292-8398",
  26.       "Telefone2": "",
  27.       "Administrador": 1,
  28.       "Pagamentos": 1,
  29.       "Situacao": "A"
  30.     },
  31.     {
  32.       "Nome": "Maria da Silva",
  33.       "Login": "maria@ondesk.com.br",
  34.       "Apelido": "Maria",
  35.       "Telefone1": "(35) 3292-8398",
  36.       "Telefone2": "",
  37.       "Administrador": 0,
  38.       "Pagamentos": 0,
  39.       "Situacao": "A"
  40.     }
  41.   ]
  42. }

Informações não disponíveis para a resolução deste dispositivo.

Resposta

  1. {
  2.   "Codigo": 0,
  3.   "Descricao": "A operação foi executada com sucesso.",
  4.   "Objeto":
  5.   {
  6.     "Codigo": 100000,
  7.     "Interno": 1,
  8.     "Nome": "Lac Sistemas LTDA",
  9.     "Fantasia": "Lac Sistemas",
  10.     "Email": "suporte@lacsistemas.com.br",
  11.     "Grupo": "",
  12.     "Situacao": "A",
  13.     "Endereco": "Rua General Costa Campos",
  14.     "Numero": "65",
  15.     "Complemento": "Sala 301",
  16.     "Bairro": "Centro",
  17.     "Cidade": "Alfenas",
  18.     "Estado": "MG",
  19.     "Cep": "37130-000",
  20.     "Telefone1": "(35) 3292-8398",
  21.     "Telefone2": "",
  22.     "Pessoa": "J",
  23.     "Documento": "04.856.207/0001-13",
  24.     "Cadastro": "10/06/2014 13:05:30",
  25.     "Usuarios":
  26.     [
  27.       {
  28.         "Codigo": 100000,
  29.         "Nome": "João de Barro",
  30.         "Login": "joao@ondesk.com.br",
  31.         "Apelido": "João",
  32.         "Telefone1": "(35) 3292-8398",
  33.         "Telefone2": "",
  34.         "Administrador": 1,
  35.         "Pagamentos": 1,
  36.         "Cadastro": "10/06/2014 13:05:31"
  37.       },
  38.       {
  39.         "Codigo": 100001,
  40.         "Nome": "Maria da Silva",
  41.         "Login": "maria@ondesk.com.br",
  42.         "Apelido": "Maria",
  43.         "Telefone1": "(35) 3292-8398",
  44.         "Telefone2": "",
  45.         "Administrador": 0,
  46.         "Pagamentos": 0,
  47.         "Cadastro": "10/06/2014 13:05:32"
  48.       }
  49.     ]
  50.   }
  51. }

Informações não disponíveis para a resolução deste dispositivo.

DELETE clientes/excluir

Parâmetros

Parâmetro Tipo Descrição
Codigo Inteiro Código de identificação do cliente.

Informações não disponíveis para a resolução deste dispositivo.

Resposta

  1. {
  2.   "Codigo": 0,
  3.   "Descricao": "A operação foi executada com sucesso.",
  4.   "Objeto": null,
  5. }

Informações não disponíveis para a resolução deste dispositivo.

GET grupos/listar

Resposta

  1. [
  2.   {
  3.     "Codigo": 100000,
  4.     "Nome": "- - -",
  5.     "Situacao": "A"
  6.   },
  7.   {
  8.     "Codigo": 100001,
  9.     "Nome": "Contas Online",
  10.     "Situacao": "A"
  11.   }
  12. ]

Informações não disponíveis para a resolução deste dispositivo.