Serodonto API

Introdução

Para efetuar qualquer ação com nossa API basta enviar uma requição REST para a URL da operação desejada. Tanto os dados enviados no corpo da requisição quanto o retorno estão no formato JSON, com exceção dos filtros enviados pela própria URL.

Toda requisição deve ser enviada com um cabeçalho de autenticação BASIC, possuindo o valor usuário:chave do usuário da API, codificado na Base64.

Os status HTTP que podem ser retornados são:

200 - OK
401 - Não Autorizado
404 - Não Encontrado
400 - Requisição Inválida
500 - Erro Interno do Servidor

No Serodonto, os horários das agendas são gerados previamente ao uso, e não gerados conforme os agendamentos são feitos, sendo assim, é necessário enviar o id_agenda do horário correspondente nas requisições dos agendamentos. Cada agendamento pode ser composto por um ou mais horários, dependendo da duração. É possível recuperar os dias com horários vagos através do GET Datas, e recuperar todos os horários vagos em um determinado período através do GET Horarios, assim obtendo o(s) id_agenda(s) do(s) horário(s) desejado(s).

Para agendar basta enviar um POST Agendamentos, enviando os dados no corpo da requisição em formato JSON. Caso o cliente já exista, seu identificador é recuperado através de um GET Clientes com os filtros desejados, caso não, um novo pode ser cadastrado através de um POST Clientes. Todos os dados necessários para agendar podem ser recuperados através das outras requisições.

Existem dois tipos de agenda, a do dentista e a do equipo, qual será utilizada depende do parâmetro tipo_agenda, cujo pode assumir os valores 1 para dentista e 2 para equipo, sendo 1 o padrão. Basta enviar o id_dentista ou o id_equipo para cada tipo de agenda, ou dependendo da requisição, o id_dentista junto ao id_equipo se o agendamento utiliza ambos. O equipo, diferente dos outros objetos do sistema, utiliza o mesmo objeto que o dentista, porém com um Guid como id no campo identificador, cujo é o id_equipo nas requisições, enquanto os outros objetos utilizam o id como Integer.

Recomendamos utilizar o processo do POST Agendamentos para realizar um agendamento, porém existe um outro método. O POST Agendamentos/Agendar também agenda um cliente, com a diferença de que não precisa existir um horário disponível e vago para poder agendar, caso exista o mesmo será utilizado, e caso não exista, um horário na data e hora especificadas será criado e agendado. Porém é necessário que o dentista tenha horários gerados no dia correspondente para poder agendar. Isso pode criar horários duplicados e não checa os horários disponíveis para atendimento que o dentista realmente tem, por isso utilize o método que se adeque mais na lógica do seu sistema.

Boletos

API	Descrição
GET Boletos/PorVencimento	Retorna os boletos por data de vencimento utilizando os parametros: chave_api, data_ini e data_fim. Exemplo: https://api.serodonto.com.br/Boletos/PorVencimento?chave_api=chave&data_ini=2022-01-01&data_fim=2022-01-01 Filtros obrigatórios.
POST Boletos	No documentation available.

Enderecos

API	Descrição
GET enderecos/CEP	Retorna os dados do endereço utilizando o filtro de: cep. Exemplo: https://api.serodonto.com.br/enderecos/CEP?cep=cep Filtros obrigatórios.
POST Enderecos	No documentation available.

Dentistas

API	Descrição
GET Equipos?id={id}&chave_api={chave_api}	Retorna o equipo com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/equipos?id=A9DF70EA-4F33-4A58-947E-9D6E37DDD47B&chave_api=chave Filtros obrigatórios.
GET Dentistas	Retorna os dentistas e os equipos que agendam online utilizando os filtros de: chave_api, nome_tratamento e especializacao. Os equipos somente serão retornado caso a clínica possua esse tipo de atendimento. Cada objeto retornado possui um tipo de atendimento. Podendo ter os seguintes valores: 1 para dentista e 2 para equipo. O equipo, diferente dos outros objetos do sistema, utiliza o mesmo objeto que o dentista, porém com um Guid* como id no campo identificador, cujo é o id_equipo nas requisições, enquanto os outros objetos utilizam o id como Integer. Exemplo: https://api.serodonto.com.br/dentistas?chave_api=chave&nome_tratamento=pedro&especializacao=teste * Filtros obrigatórios.
GET Dentistas/{id}?chave_api={chave_api}	Retorna o dentista com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/dentistas/1?chave_api=chave Filtros obrigatórios.
PUT Dentistas/{id}	Altera o dentista com o identificador passado. Os campos aceitos no corpo da requisição são: imagem. Exemplo: https://api.serodonto.com.br/dentistas/1
POST Dentistas	No documentation available.

Clientes

API	Descrição
PUT UpdatePasta	Altera o cliente com a pasta passada. Os campos aceitos no corpo da requisição são: chave_api, nome_completo, telefone, cpf, sexo e data_nascimento. É possível enviar mais campos para informações detalhadas do cliente, para isso é preciso usar o parâmetro campos_adicionais. Os campos adicionais são: pasta, nome_tratamento, id_situacao, id_status, estado_civil, profissao, rg, observacao, observacao_agendamentos, observacao_financeira, observacao_prontuario, cep, cidade, uf, bairro, endereco, numero, complemento, estrangeiro, telefone2, telefone3, contato, id_dentista, id_genero_marketing, periodo, id_indicacao, tipo_indicacao, id_tabela, numero_carteira, validade_carteira, plano, tipo_sanguineo, nacionalidade, naturalidade, orgao_expedidor, local_trabalho, telefone_comercial, declarante_imposto, e responsavel. Os campos do responsável são: nome_completo, cpf, sexo, telefone, data_nascimento, email, grau_parentesco, profissao, rg, cep, cidade, uf, bairro, endereco, numero, complemento, telefone2, telefone3, estado_civil, nacionalidade, orgao_expedidor, local_trabalho e telefone_comercial. Alguns campos possuem validações em seus formatos, sendo alguns deles: cpf: Número contendo 11 digitos que seja um cpf válido. Exemplo: 12345678901. sexo: MASCULINO ou FEMININO. telefone: Número contendo 10 ou 11 digitos, sem o código do país. Exemplo: 14950505050 data_nascimento: Data no padrão do JSON. Exemplo: 2000-04-15T00:00:00. Para mais informações sobre os campos, cheque a página da requisição. Exemplo: https://api.serodonto.com.br/UpdatePasta?pasta=1 Campos obrigatórios.
GET ProximosAgendamentos	Retorna os próximos agendamentos do cliente utilizando os filtros de: chave_api, id_cliente, tipo_agenda, (id_dentista ou id_equipo), id_convenio e id_especializacao. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/ProximosAgendamentos?chave_api=chave&id_dentista=1&id_cliente=1&id_convenio=1&id_especializacao=1 Filtros obrigatórios.
GET Clientes	Retorna os clientes utilizando os filtros de: chave_api, nome, cpf, telefone, email e pasta. Também é necessário passar um dos parâmetros (nome/cpf/pasta/telefone) ou os parâmetros pagina e tamanho_pagina. É possível retornar mais campos para informações detalhadas do cliente, para isso é preciso usar o parâmetro campos_adicionais. Exemplos: https://api.serodonto.com.br/clientes?chave_api=chave&cpf=123.456.789-10 https://api.serodonto.com.br/clientes?chave_api=chave&nome=pedro&cpf=123.456.789-10 https://api.serodonto.com.br/clientes?chave_api=chave&cpf=123.456.789-10&telefone=00999999999 https://api.serodonto.com.br/clientes?chave_api=chave&pasta=123 https://api.serodonto.com.br/clientes?chave_api=chave&pagina=1&tamanho_pagina=25 Filtros obrigatórios.
GET Clientes/{id}?chave_api={chave_api}	Retorna o cliente com o identificador passado, utilizando os filtros de: chave_api. É possível retornar mais campos para informações detalhadas do cliente, para isso é preciso usar o parâmetro campos_adicionais. Exemplo: https://api.serodonto.com.br/clientes/1?chave_api=chave Filtros obrigatórios.
PUT Clientes/{id}	Altera o cliente com o identificador passado. Os campos aceitos no corpo da requisição são: chave_api, nome_completo, telefone, cpf, sexo e data_nascimento. É possível enviar mais campos para informações detalhadas do cliente, para isso é preciso usar o parâmetro campos_adicionais. Os campos adicionais são: pasta, nome_tratamento, id_situacao, id_status, estado_civil, profissao, rg, observacao, observacao_agendamentos, observacao_financeira, observacao_prontuario, cep, cidade, uf, bairro, endereco, numero, complemento, estrangeiro, telefone2, telefone3, contato, id_dentista, id_genero_marketing, periodo, id_indicacao, tipo_indicacao, id_tabela, numero_carteira, validade_carteira, plano, tipo_sanguineo, nacionalidade, naturalidade, orgao_expedidor, local_trabalho, telefone_comercial, declarante_imposto, e responsavel. Os campos do responsável são: nome_completo, cpf, sexo, telefone, data_nascimento, email, grau_parentesco, profissao, rg, cep, cidade, uf, bairro, endereco, numero, complemento, telefone2, telefone3, estado_civil, nacionalidade, orgao_expedidor, local_trabalho e telefone_comercial. Alguns campos possuem validações em seus formatos, sendo alguns deles: cpf: Número contendo 11 digitos que seja um cpf válido. Exemplo: 12345678901. sexo: MASCULINO ou FEMININO. telefone: Número contendo 10 ou 11 digitos, sem o código do país. Exemplo: 14950505050 data_nascimento: Data no padrão do JSON. Exemplo: 2000-04-15T00:00:00. Para mais informações sobre os campos, cheque a página da requisição. Exemplo: https://api.serodonto.com.br/clientes/1 Campos obrigatórios.
POST Clientes	Adiciona um cliente. Caso o cliente já exista, os dados dele serão retornados. Os campos aceitos no corpo da requisição são: chave_api, nome_completo, telefone, cpf, sexo e data_nascimento. É possivel validar a existencia de cliente existente através de uma unica chave para isso é necessario passar o parametro 'campo_chave' na Querystring sendo os valores aceitos: "cpf", "pasta", "nome_e_telefone". É possível enviar mais campos para informações detalhadas do cliente, para isso é preciso usar o parâmetro campos_adicionais. Os campos adicionais são: pasta, nome_tratamento, id_situacao, id_status, estado_civil, profissao, rg, observacao, observacao_agendamentos, observacao_financeira, observacao_prontuario, cep, cidade, uf, bairro, endereco, numero, complemento, estrangeiro, telefone2, telefone3, contato, id_dentista, id_genero_marketing, periodo, id_indicacao, tipo_indicacao, id_tabela, numero_carteira, validade_carteira, plano, tipo_sanguineo, nacionalidade, naturalidade, orgao_expedidor, local_trabalho, telefone_comercial, declarante_imposto, id_categoria e responsavel. Os campos do responsável são: nome_completo, cpf, sexo, telefone, data_nascimento, email, grau_parentesco, profissao, rg, cep, cidade, uf, bairro, endereco, numero, complemento, telefone2, telefone3, estado_civil, nacionalidade, orgao_expedidor, local_trabalho e telefone_comercial. Alguns campos possuem validações em seus formatos, sendo alguns deles: cpf: Número contendo 11 digitos. Exemplo: 12345678901. sexo: MASCULINO ou FEMININO. telefone: Número contendo 10 ou 11 digitos, sem o código do país. Exemplo: 14950505050 data_nascimento: Data no padrão do JSON. Exemplo: 2000-04-15T00:00:00. Para mais informações sobre os campos, cheque a página da requisição. Campos obrigatórios.
GET Clientes/{id}/imagens?chave_api={chave_api}	Retorna as imagens do cliente com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/clientes/1/imagens?chave_api=chave Filtros obrigatórios.
POST Clientes/{id}/imagens?chave_api={chave_api}	Envia as imagens do cliente com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/clientes/1/imagens?chave_api=chave Filtros obrigatórios.
GET clientes/dados_ir?cpf={cpf}&ano={ano}&chave_api={chave_api}	Retorna os dados de imposto de renda do cliente, utilizando os filtros de: chave_api, cpf, ano. Exemplo: https://api.serodonto.com.br/clientes/dados_ir?cpf=cpf&ano=ano&chave_api=chave Filtros obrigatórios.
GET clientes/aniversariantes	Retorna os clientes utilizando os filtros de: dia_ini, mes_ini, ano_ini, dia_fim, mes_fim, ano_fim, dados_adicionais Caso passar for filtrar o ano, é necessário passar ambos os parametros referentes ao ano Exemplos: https://api.serodonto.com.br/clientes/aniversariantes?dia_ini=1&mes_ini=1&ano_ini=1990&dia_fim=31&mes_fim=1&ano_ini=2000&dados_adicionais=true * Filtros obrigatórios.
POST clientes/RealizaramProcedimentos	Retorna os clientes que realizaram procedimentos especificados dentro de um periodo utilizando os filtros de: data_inicial, data_final, procedimentos* Sendo que o parametros procedimentos é a lista de inteiros com os ids de procedimento Exemplos: https://api.serodonto.com.br/clientes/RealizaramProcedimentos?campos_adicionais=true * Filtros obrigatórios.
GET Clientes?cidade={cidade}&uf={uf}	No documentation available.

Horarios

API	Descrição
GET horarios	Retorna os horários utilizando os filtros de: chave_api, tipo_agenda, (id_dentista ou id_equipo), data (ou data_inicial e data_final), id_cliente e id_especializacao. Quando o id_cliente não é informado somente os horários vagos são retornados. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/horarios?chave_api=chave&id_dentista=1&data_inicial=2000-04-15&data_final=2000-04-20&id_cliente=1&id_especializacao=1 Filtros obrigatórios.
GET horarios/simplificados	Retorna os horários utilizando os filtros de: chave_api, tipo_agenda, data_inicial, data_final, (id_cliente ou cpf) Quando o id_cliente não é informado somente os horários vagos são retornados. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/horarios/simplificados?chave_api=chave&data_inicial=2000-04-15&data_final=2000-04-20&id_cliente=1 * Filtros obrigatórios.
POST Horarios	No documentation available.

Cobrancas

API	Descrição
GET Cobrancas/itens_guia	Retorna as cobranças de um cliente com os itens de guia em dentro do periodo filtrado. Os campos aceitos no corpo da requisição são: (id_cliente ou cpf), data_inicial, data_final, filtrar_por. O parametro filtrar_por aceita baixa, pagamento ou vencimento. se um valor diferente for passado, filtra-ra por data de emissao Exemplo: https://api.serodonto.com.br/cobrancas/itens_guia?id_cliente=1&data_inicial=2024-01-01&data_final=2024-01-07&filtrar_por=baixa Exemplo: https://api.serodonto.com.br/cobrancas/itens_guia?cpf=000.000.006-04&data_inicial=2024-01-01&data_final=2024-01-07&filtrar_por=baixa Campos obrigatórios.
GET Cobrancas/ListaEnvioFinanceiro	Retorna as cobranças utilizando os filtros de: data_inicial, data_final, tipo_conta, id_situacao, id_status, filtrar_por, atrasadas, todas_parcelas e id_tipo_documento. O tipo_conta definirá se filtrara por todos, a receber ou recebidas, podendo assumir os seguintes valores: -1 para Todos, 0 para A Receber, 1 para Recebidas, sendo -1 o padrão. Os para conseguir os parametros id_situacao, id_status e id_tipo_documento, realize as consultas: /SituacoesClientes, /StatusCliente, /TiposDocumento Exemplo: https://api.serodonto.com.br/cobrancas/ListaEnvioFinanceiro?id_situacao=-1&id_status=-1&filtrar_por=vencimento&data_inicial=2025-01-01&data_final=2025-01-31&tipo_conta=-1&atrasadas=true&todas_parcelas=true&id_tipo_documento=-1? * Filtros obrigatórios.
GET Cobrancas	Retorna as cobranças de um cliente em especifico dentro do periodo filtrado. Os campos aceitos no corpo da requisição são: (id_cliente ou cpf), data_inicial, data_final, filtrar_por. O parametro filtrar_por aceita baixa, pagamento ou vencimento. se um valor diferente for passado, filtra-ra por data de emissao Exemplo: https://api.serodonto.com.br/cobrancas?id_cliente=1&data_inicial=2024-01-01&data_final=2024-01-31&filtrar_por=baixa Exemplo: https://api.serodonto.com.br/cobrancas?cpf=000.000.006-04&data_inicial=2024-01-01&data_final=2024-01-31&filtrar_por=baixa Campos obrigatórios.
POST Cobrancas	No documentation available.

Orcamentos

API	Descrição
GET orcamentos/NaoAprovados	Retorna os orcamentos sem data de autorizacao utilizando os filtros de: data_inicial* e data_final. Exemplo: https://api.serodonto.com.br/orcamentos/NaoAprovados?data_inicial=2025-01-01&data_final=2025-01-31 Filtros obrigatórios.
POST Orcamentos	No documentation available.

OperadorasCartao

API	Descrição
GET operadoras_cartoes?chave_api={chave_api}	Retorna a lista com todas as operadoras de cartão Exemplo: https://api.serodonto.com.br/operadoras_cartoes?chave_api=chave
POST operadoras_cartoes	No documentation available.

BandeirasCartao

API	Descrição
GET bandeiras_cartao?chave_api={chave_api}	Retorna a lista com todas as operadoras de cartão Exemplo: https://api.serodonto.com.br/bandeiras_cartao?chave_api=chave
POST bandeiras_cartao	No documentation available.

Agendamentos

API	Descrição
POST Agendamentos/Agendar	Agenda um cliente existente em uma data e horário específicos, criando o horário caso não exista e agendando o cliente. Não é possível agendar em um dia que está vazio. Caso o id_ocorrencia e id_convenio não sejam informados, os valores atribuidos a eles nos parâmetros serão utilizados. Os campos aceitos no corpo da requisição são: chave_api, hora, (id_dentista ou id_equipo), id_cliente, id_especializacao, tipo_agenda, id_ocorrencia, id_convenio, id_colaborador e observacao. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Campos obrigatórios.
POST Agendamentos/Confirmar?id_agenda={id_agenda}&chave_api={chave_api}	Confirma o agendamento identificado por qualquer horário incluso nele passado pelo id_agenda* e chave_api. Exemplo: https://api.serodonto.com.br/agendamentos/confirmar?id_agenda=1&chave_api=1 Filtros obrigatórios.
POST Agendamentos/Desmarcar?id_agenda={id_agenda}&chave_api={chave_api}	Desmarca o agendamento identificado por qualquer horário incluso nele passado pelo id_agenda, chave_api e motivo, alterando a frequência para desmarcado e normalmente gerando um novo horário vago, dependendo da configuração da empresa. O motivo é salvo na observação. Exemplo: https://api.serodonto.com.br/agendamentos/desmarcar?id_agenda=1&chave_api=1&motivo=exemplo * Filtros obrigatórios.
POST Agendamentos/Reagendar?id_agenda={id_agenda}&chave_api={chave_api}	Reagenda o agendamento identificado por qualquer horário incluso nele passado pelo id_agenda* e chave_api, alterando a frequência para reagendou e normalmente gerando um novo horário vago, dependendo da configuração da empresa. Esse método apenas altera a frequência do agendamento, para agendar em um outro horário é necessário efetuar um POST em Agendamentos logo após esse. Exemplo: https://api.serodonto.com.br/agendamentos/reagendar?id_agenda=1&chave_api=1 Filtros obrigatórios.
GET Agendamentos/ListaEnvioAgendamentos	Retorna os agendamentos utilizando os filtros de: data_inicial, data_final, tipo_agenda, id_dentista, id_equipo, id_curso, id_confirmacao, id_frequencia e id_ocorrencia. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista, 2 para equipo, 4 para curso, sendo 1 o padrão. Os para conseguir os parametros id_dentista, id_equipo, id_curso, id_confirmacao, id_frequencia e id_ocorrencia, realize as consultas: /Dentistas, /Dentistas, /Cursos, /Confirmacoes, /Frequencias, /Ocorrencias Para filtrar agendamentos sem confirmação passar id_confirmacao=-2 Exemplo: https://api.serodonto.com.br/agendamentos/ListaEnvioAgendamentos?data_inicial=2025-01-01&data_final=2025-01-31&tipo_agenda=1&id_dentista=1&id_equipo=00000000-0000-0000-0000-000000000000&id_curso=00000000-0000-0000-0000-000000000000&id_confirmacao=-1&id_frequencia=-1&id_ocorrencia=-1 * Filtros obrigatórios.
GET Agendamentos	Retorna os agendamentos utilizando os filtros de: chave_api, id_cliente, data_inicial, data_final, tipo_agenda, id_dentista, id_equipo, id_convenio e id_especializacao. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/agendamentos?chave_api=chave&id_dentista=1&id_cliente=1&data_inicial=2000-04-15&data_final=2000-04-20&id_convenio=1&id_especializacao=1 * Filtros obrigatórios.
PUT Agendamentos/{id}	Altera o agendamento identificado por qualquer horário incluso nele passado pelo identificador. A frequência pode gerar um novo horário vago, dependendo da configuração da empresa Os campos aceitos no corpo da requisição são: chave_api, id_frequencia, id_ocorrencia e observacao. Exemplo: https://api.serodonto.com.br/agendamentos/1 Campos obrigatórios.

ListaAgendamentos

API	Descrição
GET ListaAgendamentos/PorDentista	Retorna os agendamentos agrupando-os por dentista utilizando os filtros de: chave_api, data_inicial, data_final, tipo_agenda, id_dentista, id_convenio e id_especializacao. O id_dentista precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/ListaAgendamentos/PorDentista?chave_api=chave&id_dentista=1&data_inicial=2000-04-15&data_final=2000-04-20&id_convenio=1&id_especializacao=1 Filtros obrigatórios.
GET ListaAgendamentos	Retorna os agendamentos agrupando-os por cliente utilizando os filtros de: chave_api, data_inicial, data_final, tipo_agenda, id_dentista, id_equipo, id_convenio e id_especializacao. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/ListaAgendamentos?chave_api=chave&id_dentista=1&data_inicial=2000-04-15&data_final=2000-04-20&id_convenio=1&id_especializacao=1 Filtros obrigatórios.
POST ListaAgendamentos	No documentation available.

SituacoesCliente

API	Descrição
GET SituacoesCliente	Retorna os tipos situação que um cliente pode ter. Exemplo: https://api.serodonto.com.br/SituacoesClientes
POST SituacoesCliente	No documentation available.

Estatisticas

API	Descrição
POST Estatisticas	No documentation available.

Datas

API	Descrição
GET Datas	Retorna as datas com horários utilizando os filtros de: chave_api, tipo_agenda, (id_dentista ou id_equipo), data_inicial, data_final, id_cliente e id_especializacao. Quando o id_cliente não é informado somente as datas com horários vagos são retornadas. O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão. Exemplo: https://api.serodonto.com.br/datas?chave_api=chave&id_dentista=1&data_inicial=2000-04-15&data_final=2000-04-20&id_cliente=1&id_especializacao=1 * Filtros obrigatórios.
POST Datas	No documentation available.

API

Descrição

GET Datas

Retorna as datas com horários utilizando os filtros de: chave_api*, tipo_agenda, (id_dentista ou id_equipo)*, data_inicial*, data_final*, id_cliente e id_especializacao.
Quando o id_cliente não é informado somente as datas com horários vagos são retornadas.
O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão.
Exemplo: https://api.serodonto.com.br/datas?chave_api=chave&id_dentista=1&data_inicial=2000-04-15&data_final=2000-04-20&id_cliente=1&id_especializacao=1
* Filtros obrigatórios.

POST Datas

No documentation available.

Procedimentos

API	Descrição
GET Procedimentos	Retorna os procedimentos que estão presentes na tabela tuss e os que foram cadastrados pela empresa utilizando os filtros de: data_inicial, data_final. Exemplo: https://api.serodonto.com.br/procedimentos?data_inicial=2025-01-01&data_final=2025-01-31 * Filtros obrigatórios.
POST Procedimentos	No documentation available.

Cursos

API	Descrição
GET Cursos	Retorna os cursos cadastrados pela empresa. Para trazer os dados de forma detalhada é necessário passar dados_adicionais=true. Exemplo: https://api.serodonto.com.br/Cursos?dados_adicionais=true
POST Cursos	No documentation available.

Especializacoes

API	Descrição
GET Especializacoes	Retorna as especializações utilizando os filtros de: chave_api, especializacao e id_dentista. Quando o id_dentista é informado somente as especializações atendidas por ele são retornadas. Os equipos atendem todas as especializações. Exemplo: https://api.serodonto.com.br/especializacoes?chave_api=chave&especializacao=teste&id_dentista=1 Filtros obrigatórios.
GET Especializacoes/{id}?chave_api={chave_api}	Retorna a especialização com o identificador passado., utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/especializacoes/1?chave_api=chave Filtros obrigatórios.
POST Especializacoes	No documentation available.

Pagamento_DataBaixa

API	Descrição
GET Pagamento_DataBaixa?chave_api={chave_api}	Retorna os dados do Contas à Receber procurando pela data de baixa utilizando os filtros de: chave_api, data_ini, data_fim* Exemplo: https://api.serodonto.com.br/pagamento_databaixa?chave_api=chave&data_ini=2023-01-01&data_fim=2023-01-31 * Filtros obrigatórios.
POST Pagamento_DataBaixa	No documentation available.

Ocorrencias

API	Descrição
GET Ocorrencias	Retorna as ocorrências utilizando os filtros de: chave_api* e ocorrencia. Exemplo: https://api.serodonto.com.br/ocorrencias?chave_api=chave&ocorrencia=avaliacao * Filtros obrigatórios.
GET Ocorrencias/{id}?chave_api={chave_api}	Retorna a ocorrência com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/ocorrencias/1?chave_api=chave Filtros obrigatórios.
POST Ocorrencias	No documentation available.

Pagamento_DataCaixa

API	Descrição
GET Pagamento_DataCaixa?chave_api={chave_api}	Retorna os dados do Contas à Receber procurando pela data de fechamento do caixa utilizando os filtros de: chave_api, data_ini, data_fim* Exemplo: https://api.serodonto.com.br/pagamento_datacaixa?chave_api=chave&data_ini=2023-01-01&data_fim=2023-01-31 * Filtros obrigatórios.
POST Pagamento_DataCaixa	No documentation available.

TiposDocumento

API	Descrição
GET TiposDocumento	Retorna os tipos de documento cadastrados pela empresa. Exemplo: https://api.serodonto.com.br/TiposDocumento
POST TiposDocumento	No documentation available.

Frequencias

API	Descrição
GET Frequencias	Retorna as frequências utilizando os filtros de: chave_api* e frequencia. Exemplo: https://api.serodonto.com.br/frequencias?frequencia=agendado * Filtros obrigatórios.
GET Frequencias/{id}?chave_api={chave_api}	Retorna a frequência com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/frequencias/1?chave_api=chave Filtros obrigatórios.
POST Frequencias	No documentation available.

StatusCliente

API	Descrição
GET StatusCliente	Retorna os status de cliente cadastrados pela empresa. Exemplo: https://api.serodonto.com.br/StatusCliente
GET StatusCliente/{id}?chave_api={chave_api}	Retorna o status de cliente filtrando pelo id do status(id_status) Exemplo: https://api.serodonto.com.br/StatusCliente/5?chave_api=chave_api
PUT StatusCliente/{id}?chave_api={chave_api}	Atualiza um status de cliente Exemplo: https://api.serodonto.com.br/StatusCliente/5?chave_api=chave_api
POST StatusCliente?chave_api={chave_api}	Cria um novo status de cliente Exemplo: https://api.serodonto.com.br/StatusCliente?chave_api=chave_api
POST StatusCliente	No documentation available.

Convenios

API	Descrição
GET Convenios	Retorna os convênios utilizando os filtros de: chave_api, convenio e id_dentista ou id_cliente. Quando o id_dentista é informado somente os convênios atendidos por ele são retornados. Quando o id_cliente é informado somente o convênio dele é retornado. Se o id_dentista e o id_cliente forem informados, somente o id_dentista será utilizado. Exemplo: https://api.serodonto.com.br/convenios?chave_api=chave&convenio=teste&id_dentista=1 Filtros obrigatórios.
GET Convenios/{id}?chave_api={chave_api}	Retorna o convênio com o identificador passado, utilizando os filtros de: chave_api. Exemplo: https://api.serodonto.com.br/convenios/1?chave_api=chave Filtros obrigatórios.
POST Convenios	No documentation available.

Dados_Prontuario

API	Descrição
GET Dados_Prontuario?chave_api={chave_api}	Retorna os dados do prontuario utilizando os filtros de: chave_api, data_ini, data_fim* Exemplo: https://api.serodonto.com.br/dados_prontuario?chave_api=chave&data_ini=2023-01-01&data_fim=2023-01-31 * Filtros obrigatórios.
GET Dados_Prontuario	No documentation available.
POST Dados_Prontuario	No documentation available.

Confirmacoes

API	Descrição
GET Confirmacoes	Retorna os tipos de confirmação de agenda cadastrados pela empresa. Exemplo: https://api.serodonto.com.br/Confirmacoes
POST Confirmacoes	No documentation available.

Pagamento_DataEmissao

API	Descrição
GET Pagamento_DataEmissao?chave_api={chave_api}	Retorna os dados do Contas à Receber procurando pela data de emissão utilizando os filtros de: chave_api, data_ini, data_fim* Exemplo: https://api.serodonto.com.br/pagamento_dataemissao?chave_api=chave&data_ini=2023-01-01&data_fim=2023-01-31 * Filtros obrigatórios.
POST Pagamento_DataEmissao	No documentation available.

Empresas

API	Descrição
GET Empresas?chave_api={chave_api}	Retorna os dados da empresa ou clínica com a chave passada. Exemplo: https://api.serodonto.com.br/empresas?chave_api=chave
POST Empresas	No documentation available.

Base

API	Descrição
POST Base	No documentation available.

Perguntas Frequentes

Como obtemos o usuário e a chave da API?

Quando entrar em contato conosco para a integração, você receberá um usuário e uma chave, e poderá visualizá-los através do sistema do Serodonto, no menu lateral, em Utilitários, Parâmetros API. São eles que serão enviados no cabeçalho das requisições.

O usuário que deve ser enviado no cabeçalho é exatamente o usuário utilizado para acessar o sistema do Serodonto?

Não, o usuário é separado do usuário que acessa o sistema, você receberá um usuário e uma chave para utilizar a API. O outro usuário e senha para acessar o sistema podem serem fornecidos pela clínica que está realizando a integração.

Existe algum ambiente de testes, em que possamos realizar as requisições sem alterar a agenda que já está em produção?

Sim, te enviaremos um usuário e chave de uma clínica de homologação, assim como o usuário e senha para acessar o sistema nessa clínica, onde os testes podem ser realizados e posteriormente visualizados no sistema para a validação do funcionamento da integração.