NAV Navigation
HTTP

Autorização

Para realizar qualquer tipo de requisição (GET, POST) nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de Token.

Para utilizar o Token nas requisições basta adiciona-lo ao header com a chave x-access-token.

Exemplo:
x-access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTA...

Em caso de dúvidas entre em contato com nosso suporte.

Empresa

Listar unidades

Exemplo Request

GET https://api.feegow.com.br/api/company/list-unity
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": {
        "matriz": [
            {
                "unidade_id" : 0,
                "nome_fantasia": "Matriz",
                "cnpj": "11.111.111.0001-16",
                "endereco": "Jose",
                "cep": "03502-060",
                "numero": "12",
                "bairro": "Sobradinho",
                "telefone_1": "(21) 1111-1111",
                "telefone_2": "(21) 2222-2222",
                "email_1": "josebaroni@feegow.com.br",
                "email_2": "maiavinicius@feegow.com.br",
                "complementos": "7 andar",
                "mapa": null
            }
        ],
        "unidades": [
            {
                "unidade_id" : 6,
                "nome_fantasia": "Filial",
                "cnpj": "11.111.111.0001-16",
                "endereco": "Estrada do Guanumbi",
                "cep": "22745-200",
                "numero": "000",
                "bairro": "Freguesia (Jacarepaguá)",
                "telefone_1": "(21) 1111-1111",
                "telefone_2": "(21) 2222-2222",
                "email_1": "josebaroni@feegow.com.br",
                "email_2": "maiavinicius@feegow.com.br",
                "complementos": null,
                "mapa": "https://goo.gl/maps/jKAAAA8QQny"
            }
        ]
    }
}

GET /company/list-unity

Lista as informações de unidades e matriz da sua clínica.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar locais

Exemplo Request

GET https://api.feegow.com.br/api/company/list-local
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "local": "Sala 01",
            "unidade_id": 6
        },
        {
            "id": 2,
            "local": "Sala 02",
            "unidade_id": 6
        },
        {
            "id": 3,
            "local": "Sala 01",
            "unidade_id": 0
        },
        {
            "id": 4,
            "local": "Sala 04",
            "unidade_id": 0
        },
        {
            "id": 5,
            "local": "Sala 05",
            "unidade_id": 0
        },
        {
            "id": 6,
            "local": "Sala 06",
            "unidade_id": 0
        },
        {
            "id": 7,
            "local": "Sala 07",
            "unidade_id": 0
        },
        {
            "id": 8,
            "local": "Sala 08",
            "unidade_id": 0
        },
        {
            "id": 9,
            "local": "Sala 09",
            "unidade_id": 0
        },
        {
            "id": 10,
            "local": "Sala 10",
            "unidade_id": 0
        },
        {
            "id": 11,
            "local": "Sala 11",
            "unidade_id": 0
        },
        {
            "id": 12,
            "local": "Sala 15",
            "unidade_id": 0
        },
        {
            "id": 13,
            "local": "Sala 17",
            "unidade_id": 0
        },
        {
            "id": 14,
            "local": "Sala 18",
            "unidade_id": 0
        },
        {
            "id": 15,
            "local": "Centro Cirúrgico",
            "unidade_id": 0
        },
        {
            "id": 16,
            "local": "k",
            "unidade_id": 0
        },
        {
            "id": 17,
            "local": "Sala triagem",
            "unidade_id": 6
        }
    ]
}

GET /company/list-local

Lista os locais relacionados

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Relatórios

Listar relatórios

Exemplo Request

GET https://api.feegow.com.br/api/reports/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

[
    {
        "id": 53,
        "Ct": "Agenda",
        "Relatorio": "Agendamentos",
        "Arquivo": "schedule-appointments",
        "sysActive": 1,
        "Permissoes": "relatoriosagendaV"
    },
    {
        "id": 49,
        "Ct": "Agenda",
        "Relatorio": "Atendimentos",
        "Arquivo": "duration-of-service",
        "sysActive": 1,
        "Permissoes": "relatoriosagendaV"
    }
]

GET /reports/list

Lista os relatórios disponíveis para utilização.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Gerar Relatório

Exemplo Request

POST https://api.feegow.com.br/api/reports/generate
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "reportId": 49,
    "route": "duration-of-service",
    "reportName": "Atendimentos",
    "columns": false,
    "filters": false,
    "data": [
        {
            "id": 2274,
            "PacienteID": 4059073,
            "AgendamentoID": 20168920,
            "Data": "22/11/2018",
            "HoraInicio": "08:08",
            "HoraFim": "08:54",
            "Obs": "",
            "sysUser": 13184,
            "ProfissionalID": 8386,
            "Triagem": "N",
            "UsuariosNotificados": null,
            "UnidadeID": 1,
            "TabelaID": null,
            "DHUp": "2018-11-22 08:54:51",
            "TempoProcedimento": "0",
            "DataMensal": "2018-11-22",
            "NomePaciente": "TESTE FEEGOW",
            "Tel1": "(47) 00000-0000",
            "Origem": "",
            "NomeLocal": "Sala 1",
            "LocalID": 21,
            "Quantidade": "1",
            "Valor": 30,
            "Duracao": "46",
            "TempoPermanencia": "55",
            "TempoAtraso": 0,
            "TipoCompromissoID": 96267,
            "EspecialidadeID": 109,
            "NomeProfissional": "JOSÉ SILVA",
            "ProcedimentoID": 96267,
            "TempoEspera": "9",
            "HoraSta": "07:59",
            "Hora": "08:20",
            "PeriodoHora": "Manhã",
            "HoraArredondada": "08:00",
            "NomeProcedimento": "Retorno",
            "NomeUnidade": "CLINICA DE TESTE"
        }
    ]
}

POST /reports/generate

Gera um relatório específico.

Parâmetros

Parâmetro Tipo Descrição
report
string Rota do relatório obtida pelo método Listar relatórios (Parâmetro "Arquivo")
DATA_INICIO
(opcional)
date dd/mm/YYYY
DATA_FIM
(opcional)
date dd/mm/YYYY

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar filtros

Exemplo Request

GET https://api.feegow.com.br/api/reports/get-filters
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta



GET /reports/get-filters

Obter filtros disponíveis para um relatório.

Parâmetros

Parâmetro Tipo Descrição
report
string Rota do relatório obtida pelo método Listar relatórios (Parâmetro "Arquivo")

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Profissionais

Listar profissionais

Exemplo Request

GET https://api.feegow.com.br/api/professional/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "ativo": true,
  "unidade_id": 1
}

Exemplo Resposta

[
    {
        "profissional_id": 19,
        "nome": "Andre de Paula",
        "CRM": "11.11111-1",
        "especialidades": [
            {
                "especialidade_id": 5,
                "nome_especialidade": "Dermatologia",
                "CBOS": 11111
            }
        ]
    }
]

GET /professional/list

Lista os nomes e ids dos profissionais. Você pode filtrar por profissional ativo ou inativo.

Parâmetros

Parâmetro Tipo Descrição
ativo
(opcional)
numeric 0 = Profissional inativo
1 = Profissional ativo
unidade_id
(opcional)
numeric ID da unidade
especialidade_id
(opcional)
numeric ID da da especialidade

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Informações e Especialidades

Exemplo Request

GET https://api.feegow.com.br/api/professional/search
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "profissional_id": 1
}

Exemplo Resposta

{
    "success": true,
    "content": {
        "informacoes": [
            {
                "CRM": "11.11111-1",
                "CPF": "111.111.111-1"
                "nome": "Vinicius",
                "foto": "9fb966e7a2e981f16d5b56eea6d90323.jpg",
                "data_nascimento": "02-05-1995",
                "sexo": "Masculino",
                "telefones": [
                    "(21) 2767-1515",
                    ""
                ],
                "celulares": [
                    "(21) 9988-03190",
                    ""
                ],
                "email": "vinicius.feegow@gmail.com",
                "idade_minima": 13
            }
        ],
        "especialidades": [
            {
                "especialidade_id": 5,
                "nome_especialidade": "Dermatologia",
                "CBOS": "225135"
            }
        ]
    }
}

GET /professional/search

Lista as informações e especialidades do profissional informado.

Parâmetros

Parâmetro Tipo Descrição
profissional_id numeric Identificação do profissional

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida
409 erro Profissional não existe

Convênios aceitos

Exemplo Request

GET https://api.feegow.com.br/api/professional/insurance
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "profissional_id": 1
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "convenio_id": 16,
            "nome": "BRADESCO"
        }
    ]
}

GET /professional/insurance

Lista todos convênios aceitos por um profissional específico.

Parâmetros

Parâmetro Tipo Descrição
profissional_id numeric Identificação do profissional

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Pacientes

Informações

Exemplo Request

GET https://api.feegow.com.br/api/patient/search
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "paciente_id": 5
}

Exemplo Resposta

{
    "success": true,
    "content": {
        "nome": "JOSE RENATO BARONI",
        "nascimento": "18-07-1998",
        "sexo": "Masculino",
        "endereco": "AV THIAGO CASTRO",
        "numero": "05",
        "complemento": "CASA",
        "bairro": "CENTRO",
        "cidade": "NATAL",
        "estado": "RJ",
        "cep": "59022020",
        "profissao": "Funcionário Público",
        "telefones": [
            "2907-1177",
            null
        ],
        "celulares": [
            "99762-1587",
            null
        ],
        "documentos": {
            "rg": "11111111111111",
            "cpf": "11111111"
        },
        "email": [
            "josebaroni@feegow.com.br",
            null
        ],
        "convenios": [
            {
                "convenio_id": 5,
                "plano_id": 3,
                "matricula": 21212121,
                "titular": "JOSE BARONI",
                "validade": "2018-05-18"
            },
            {
                "convenio_id": null,
                "plano_id": null,
                "matricula": null,
                "titular": null,
                "validade": null
            },
            {
                "convenio_id": null,
                "plano_id": null,
                "matricula": null,
                "titular": null,
                "validade": null
            }
        ]
    }
}

GET /patient/search

Busca informações de paciente específico.

Parâmetros

Parâmetro Tipo Descrição
paciente_id numeric Identificação do paciente

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida
409 erro Paciente não existe

Listar pacientes

Exemplo Request

GET https://api.feegow.com.br/api/patient/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "limit": 5,
  "offset" : 1
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "patient_id": 9,
            "nome": "ANA CAROLINA GOMES REBELO MELO"
        },
        {
            "patient_id": 10,
            "nome": "ADRIANA GONDIM VIEIRA GONÇALVES"
        },
        {
            "patient_id": 11,
            "nome": "ARTHUR CESAR DANTAS DA SILVA"
        },
        {
            "patient_id": 12,
            "nome": "BRENDA RIBEIRO GIRAO"
        },
        {
            "patient_id": 13,
            "nome": "INGRID RIBEIRO TAVARES"
        }
    ]
}

GET /patient/list

Lista todos pacientes cadastrados.

Para utilizar o sistema de pagination defina a posição inicial (offset) e o limite de resultados (limit).

Exemplo
offset: 5
limit: 10

Irá retornar 10 registros a partir do quinto.

Parâmetros

Parâmetro Tipo Descrição
limit
(opcional)
numeric Limite na quantidade de resultados que irão ser retornados
offset
(opcional)
numeric Número de registros que irão ser pulados na requisição

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Buscar paciente

Exemplo Request

GET https://api.feegow.com.br/api/patient/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "cpf": 12933447803,
  "telefone" : 999999999
}

Exemplo Resposta

{

    "success": true,
    "content": [
        {
            "patient_id": 112903,
            "nome": "Rafaela de Menezes da Rocha"
        }
    ]
}

Buscar paciente passando por cpf e celular.

Parâmetro Tipo Descrição
cpf numeric CPF do paciente, 11 digitos sem pontos e hífen
telefone numeric Celular do paciente

Criar paciente

Exemplo Request

POST https://api.feegow.com.br/api/patient/create
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "nome_completo": "JOSE RENATO BARONI",
  "cpf" : "11111111111",
  "data_nascimento" : "03-09-1998",
  "genero" : "M",
  "telefone" : "2127678745",
  "email" : "josebaroni@feegow.com.br",
  "origem_id": 1,
  "tabela_id": 5,
}

Exemplo Resposta

{
    "success": true,
    "content": {
        "paciente_id": 6655
    }
}

POST /patient/create

Cria um novo paciente e retorna o paciente_id.

Parâmetros

Parâmetro Tipo Descrição
nome_completo string Nome do paciente
cpf numeric CPF do paciente, 11 digitos
sem pontos e hífen
email
(opcional)
string E-mail do paciente
data_nascimento
(opcional)
date Data de nascimento do paciente
(dd-mm-yyyy)
sexo
(opcional)
string M = Masculino
F = Feminino
tabela_id
(opcional)
string ID da tabela particular
origem_id
(opcional)
string ID da origem
telefone
(opcional)
string Telefone do paciente

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar origens

Exemplo Request

GET https://api.feegow.com.br/api/patient/list-sources
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "origem_id": 1,
            "nome_origem": "Eventos2"
        }
    ]
}

GET /patient/list-sources

Lista todas origens.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar tabelas particulares

Exemplo Request

GET https://api.feegow.com.br/api/patient/list-privates
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "tabela_id": 1,
            "nome_tabela": "Exemplo"
        }
    ]
}

GET /patient/list-privates

Lista todas tabelas particulares.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Especialidades

Listar especialidades

Exemplo Request

GET https://api.feegow.com.br/api/specialties/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "especialidade_id": 157,
            "nome": "Cirurgião dentista (endodontia)"
        },
        {
            "especialidade_id": 98,
            "nome": "Médico dermatologista"
        }
    ]
}

GET /specialties/list

Lista todas especialidades disponíveis para agendamento.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar especialidade na unidade

Exemplo Request

GET https://api.feegow.com.br/api/specialties/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "UnitID": 1
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "especialidade_id": 212,
            "nome": "Auxiliar de enfermagem"
        },
        {
            "especialidade_id": 157,
            "nome": "Cirurgião dentista (endodontia)"
        },
        {
            "especialidade_id": 112,
            "nome": "Médico alergista/imunologista"
        },
        {
            "especialidade_id": 96,
            "nome": "Médico cardiologista"
        },
        {
            "especialidade_id": 98,
            "nome": "Médico dermatologista"
        },
        {
            "especialidade_id": 110,
            "nome": "Médico neurocirurgião"
        },
        {
            "especialidade_id": 126,
            "nome": "Médico oftalmologista"
        },
        {
            "especialidade_id": 131,
            "nome": "Médico otorrinolaringologista"
        },
        {
            "especialidade_id": 134,
            "nome": "Médico pediatra"
        }
    ]
}

Lista todas especialidades disponíveis em uma unidade para agendamento.

Parâmetro Tipo Descrição
UnitID numeric Identificação da unidade

Financeiro

Listar fornecedores

Exemplo Request

GET https://api.feegow.com.br/api/financial/list-suppliers
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "nome_fornecedor": "Teste",
            "CEP": null,
            "endereco": null,
            "numero": null,
            "complemento": null,
            "cidade": null,
            "CNPJ": null
        },
        {
            "id": 3,
            "nome_fornecedor": "Teste",
            "CEP": "111111-11",
            "endereco": "rua teste",
            "numero": "12",
            "complemento": "",
            "cidade": "Joinville",
            "CNPJ": "11.111.111/0001-42"
        }
    ]
}

GET /financial/list-suppliers

Lista os fornecedores da clínica.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Informações do fornecedor

Exemplo Request

GET https://api.feegow.com.br/api/financial/search-supplier
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "fornecedor_id": 1
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "nome_fornecedor": "Teste",
            "CEP": null,
            "endereco": null,
            "numero": null,
            "complemento": null,
            "cidade": null,
            "CNPJ": null
        }
    ]
}

GET /financial/search-supplier

Busca informações de um fornecedor específico.

Parâmetros

Parâmetro Tipo Descrição
fornecedor_id numeric ID do fornecedor

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar repasses

Exemplo Request

GET https://api.feegow.com.br/api/financial/list-medical-transfer
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "success": true,
  "content": [
    {
      "funcao": "executante",
      "valor": 9000,
      "associacao_id": 5,
      "conta_id": 59,
      "criado_em": "2018-01-01 09:10:30",
      "situacao": "PAGO"
    },
    {
      "funcao": "executante",
      "valor": 9500,
      "associacao_id": 5,
      "conta_id": 13,
      "criado_em": "2018-01-01 09:13:30",
      "situacao": "NAO PAGO"
    }
  ]
}

GET /financial/list-medical-transfer

Busca a listagem de repasses. Os valores são tratados em centavos.

Parâmetros

Parâmetro Tipo Descrição
data_start date Listar a partir dessa data
dd-mm-YYYY
data_end date Limitar consulta até essa data
dd-mm-YYYY

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar contas

Exemplo Request

GET https://api.feegow.com.br/api/financial/list-invoice
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "data_start": "15-05-2018",
  "data_end": "15-05-2019",
  "tipo_transacao": "D",
  "unidade_id": 0
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "detalhes": [
                {
                    "invoice_id": 600056,
                    "tipo_conta": 2,
                    "conta_id": 896944,
                    "valor": 22590,
                    "descricao": null,
                    "data": "18-05-2018"
                }
            ],
            "pagamentos": [
                {
                    "pagamento_id": 600113,
                    "descricao": null,
                    "valor": 22590,
                    "data": "20-04-2018",
                    "forma_pagamento": 1,
                    "tipo_conta": 2,
                    "conta_id": 896944,
                    "parcelas": null
                }
            ]
        }
    ]
}

GET /financial/list-invoice

Lista informações de contas no sistema.

forma_pagamento

forma_id Descrição
1 Dinheiro
2 Cheque
3 Transferência
4 Boleto
5 DOC
6 TED
7 Transferência Bancária
8 Cartão de crédito
9 Cartão de débito

tipo_conta

tipo_id Descrição
1 Conta Corrente
2 Fornecedor
3 Paciente
4 Funcionário
5 Profissional
6 Convênios
7 Caixa
8 Profissional externo

Parâmetros

Parâmetro Tipo Descrição
data_start date Data de início do filtro
data_end date Data de fim do filtro
tipo_transacao numeric C = Contas a receber
D = Contas a pagar
unidade_id
(opcional)
numeric ID da unidade

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Procedimentos

Listar procedimentos

Exemplo Request

GET https://api.feegow.com.br/api/procedures/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "unidade_id": 0,
    "paciente_id": 15,
    "tipo_procedimento": 2,
    "especialidade_id": 5,
    "profissional_id": 35
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "procedimento_id": 1,
            "nome": "Consulta",
            "valor": 75000
        }
    ]
}

GET /procedures/list

Lista todos procedimentos e seus valores, os valores são determinados de acordo com o valor dos parâmetros enviados na solicitação.
Os valores são tratados em centavos.

Parâmetros

Parâmetro Tipo Descrição
tipo_procedimento numeric Tipo de procedimento
procedimento_id
(Caso não possua tipo_procedimento)
numeric Tipo de procedimento
unidade_id
(opcional)
numeric Identificação da unidade
paciente_id
(opcional)
numeric Identificação do paciente
especialidade_id
(opcional)
numeric Identificação da especialidade
profissional_id
(opcional)
numeric Identificação do profissional
nome_procedimento
(opcional)
string Nome do procedimento para filtro de busca

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Tipos de procedimentos

Exemplo Request

GET https://api.feegow.com.br/api/procedures/types
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "tipo": "Cirurgia"
        },
        {
            "id": 2,
            "tipo": "Consulta"
        },
        {
            "id": 3,
            "tipo": "Exame"
        },
        {
            "id": 4,
            "tipo": "Procedimento"
        },
        {
            "id": 9,
            "tipo": "Retorno"
        }
    ]
}

GET /procedures/types

Busca todos os tipos de procedimento. Essa identificação é utilizada em outros métodos como (/procedures/list)

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Propostas

Listar propostas por paciente

Exemplo Request

GET https://api.feegow.com.br/api/proposal/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "paciente_id": 15
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "proposal_id": 14,
            "proposal_date": "2019-03-13",
            "value": 850,
            "proposer_id": 13052,
            "proposer_name": "José da Silva",
            "proposer_role": "Profissional",
            "status": "Aguardando aprovação do cliente",
            "private_table_name": null,
            "procedimentos": {
                "label": "Exames",
                "data": [
                    {
                        "procedimento_id": 2,
                        "nome": "ECG",
                        "valor": 750
                    },
                    {
                        "procedimento_id": 17,
                        "nome": "Hemograma",
                        "valor": 100
                    }
                ]
            },
            "unidade": {
                "unidade_id" : 6,
                "nome_fantasia": "Filial",
                "cnpj": "11.111.111.0001-16",
                "endereco": "Estrada do Guanumbi",
                "cep": "22745-200",
                "numero": "000",
                "bairro": "Freguesia (Jacarepaguá)",
                "telefone_1": "(21) 1111-1111",
                "telefone_2": "(21) 2222-2222",
                "email_1": "josebaroni@feegow.com.br",
                "email_2": "maiavinicius@feegow.com.br",
                "complementos": "",
                "mapa": "https://goo.gl/maps/jKThTS8QQny"
            }
        }
    ]
}

GET /proposal/list

Lista todas propostas feitas para um paciente e seus valores, os valores são determinados de acordo com o valor dos parâmetros enviados na solicitação.
Os valores são tratados em reais (R$).

Parâmetros

Parâmetro Tipo Descrição
paciente_id numeric Identificação do paciente

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Criar proposta

Exemplo Request

POST https://api.feegow.com.br/api/proposal/create
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "proposer_id": 3531,
    "paciente_id": 4412,
    "unidade_id": 21,
    "status_id": 5,
    "proposal_date": "12-03-2018",
    "procedimentos": [
        {
            "procedimento_id": 17,
            "quantidade": 2,
            "valor": 1111,
            "desconto": 111,
            "descricao": "Aplicação na clínica"
        },
        {
            "procedimento_id": 17,
            "quantidade": 3,
            "valor": 3211,
            "desconto": 2211,
            "descricao": "Aplicação em casa"
        },
        {
            "procedimento_id": 35,
            "quantidade": 3,
            "valor": 1411,
            "desconto": 411,
            "descricao": "Tratamento"
        },
        {
            "procedimento_id": 1,
            "quantidade": 1,
            "valor": 1121,
            "desconto": 121,
            "descricao": "Consulta"
        }
    ]
}

Parâmetros

Parâmetro Tipo Descrição
proposer_id numeric Identificação do profissional
paciente_id numeric Identificação do paciente
status_id numeric Identificação do status da proposta
unidade_id
(opcional)
numeric Identificação da unidade da proposta
proposal_date array Lista com objetos definindo os procedimentos ofertados na proposta
procedimentos
(deve conter pelo menos um objeto)
array Lista com objetos definindo os procedimentos ofertados na proposta

Parâmetros dos procedimentos

Parâmetro Tipo Descrição
procedimento_id numeric Identificação do procedimento
quantidade
(opcional)
numeric Quantidade de procedimentos a serem passados
valor
(opcional)
numeric Custo total deste procedimento
desconto
(opcional)
numeric Desconto total oferecido ao procedimento
descricao
(opcional)
string Campo para descrever quaisquer detalhes do procedimento nesta proposta

Lista de status

id status
1 Aguardando aprovação do cliente
2 Aprovada pelo cliente
3 Rejeitada pelo cliente
4 Aguardando aprovação de financiamento
5 Executada

Respostas

Exemplo Resposta

{
    "success": true,
    "content": {
        "proposal_id": 25
    }
}

GET /proposals/create

Cria uma proposta definindo a lista de procedimentos com seus valores e descontos.
Os valores são tratados em reais (R$).

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Mudar status da proposta

Exemplo Request

POST https://api.feegow.com.br/api/proposal/change-status
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "proposal_id": 24,
    "status_id": 3
}

Parâmetros

Parâmetro Tipo Descrição
proposal_id numeric Identificação do profissional
status_id numeric Identificação do status da proposta

Respostas

Exemplo Resposta

{
    "success": true,
    "content": {
        "content": "Status atualizado para: Rejeitada pelo cliente"
    }
}

GET /proposals/change-status

Modifica o status de uma proposta.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Convênios

Listar convênios

Exemplo Request

GET https://api.feegow.com.br/api/insurance/list
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "convenio_id": 16,
            "nome": "BRADESCO",
            "registro_ans": "1111",
            "planos": []
        },
        {
            "convenio_id": 2,
            "nome": "CAPERJ",
            "registro_ans": "1232323",
            "planos": [
                {
                    "plano_id": 2,
                    "plano": "Alfa"
                },
                {
                    "plano_id": 7,
                    "plano": "Beta"
                },
                {
                    "plano_id": 8,
                    "plano": "Delta"
                }
            ]
        }
    ]
}

GET /insurance/list

Busca todos convênios aceitos e seus respectivos planos.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

PABX

Novo evento

Exemplo Request

POST https://api.feegow.com.br/pabx/new-event
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "operation": "R",
    "datetime": "2018-09-25 15:00:35",
    "dest": "3002",
    "channel": "locaweb",
    "caller_id": "5521997622208"
}

Exemplo Resposta

{
    "success": true
}

Registra um novo evento.

POST /pabx/new-event

Parâmetros

Parâmetro Tipo Descrição
operation string R = ring
A = answer
C = cancel
dest numeric Número do ramal
channel string Canal
caller_id string Número do telefone
datetime string Data e hora do evento
(Y-m-d H:i:s)

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Agendamentos

Tipos de status

Exemplo Request

GET https://api.feegow.com.br/api/appoints/status
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "status": "Marcado - não confirmado"
        },
        {
            "id": 2,
            "status": "Em atendimento"
        },
        {
            "id": 3,
            "status": "Atendido"
        },
        {
            "id": 4,
            "status": "Aguardando | Atendimento"
        },
        {
            "id": 5,
            "status": "Chamando | atendimento"
        },
        {
            "id": 6,
            "status": "Não compareceu"
        },
        {
            "id": 7,
            "status": "Marcado - confirmado"
        },
        {
            "id": 11,
            "status": "Desmarcado pelo paciente"
        },
        {
            "id": 15,
            "status": "Remarcado"
        },
        {
            "id": 101,
            "status": "Aguardando | Triagem"
        },
        {
            "id": 103,
            "status": "Em atendimento | Triagem"
        },
        {
            "id": 105,
            "status": "Chamando | Triagem"
        }
    ]
}

GET /appoints/status

Lista todos os tipos de status para o agendamento.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Atualizar status

Exemplo Request

GET https://api.feegow.com.br/api/appoints/statusUpdate
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
  "AgendamentoID": 100,
  "StatusID": "7",
  "Obs": "Paciente confirmou o comparecimento."
}

Exemplo Resposta

{
    "success": true,
    "content": {
        "msg": "Agendamento alterado com sucesso"
    }
}

Atualiza o status e inseri uma nota na agenda.

Parâmentro Tipo Descrição
AgendamentoID numeric Identificação do agendamento
StatusID numeric Identificação do status
Obs string Observação da alteração do status

Lista motivos

Exemplo Request

GET https://api.feegow.com.br/api/appoints/motives
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "motivo": "Solicitado pelo paciente"
        },
        {
            "id": 2,
            "motivo": "Solicitado pelo profissional"
        }

    ]
}

GET /appoints/motives

Lista todos os motivos para reagendamento ou cancelamento.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar canais

Exemplo Request

GET https://api.feegow.com.br/api/appoints/list-channel
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "id": 1,
            "canal": "Agendamento Online"
        },
        {
            "id": 2,
            "canal": "Clínica"
        }
    ]
}

GET /appoints/list-channel

Lista todos canais de agendamento disponíveis.

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Listar agendamentos

Exemplo Request

GET https://api.feegow.com.br/api/appoints/search
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "profissional_id": 1,
    "paciente_id": 100003,
    "data_start": "05-08-2018",
    "data_end": "08-08-2018"
}

Exemplo Resposta

{
    "success": true,
    "content": [
        {
            "agendamento_id": 30,
            "data": "07-08-2018",
            "horario": "09:00:00",
            "paciente_id": 100003,
            "procedimento_id": 3,
            "status_id": 1,
            "local_id": 0,
            "profissional_id": 1
        },
        {
            "agendamento_id": 35,
            "data": "06-08-2018",
            "horario": "08:00:00",
            "paciente_id": 100003,
            "procedimento_id": 3,
            "status_id": 1,
            "local_id": 0,
            "profissional_id": 1
        }
    ]
}

GET /appoints/search

Lista agendamentos por filtros.

Parâmetros

Parâmetro Tipo Descrição
agendamento_id numeric ID do agendamento
data_start
(opcional com agendamento_id)
date Data inicio do filtro.
DD-MM-YYYY
data_end
(opcional com agendamento_id)
date Data final do filtro.
DD-MM-YYYY
profissional_id
(opcional)
numeric Identificação do profissional
paciente_id
(opcional)
numeric Identificação do paciente
unidade_id
(opcional)
numeric Identificação da unidade
local_id
(opcional)
numeric Identificação do Local
especialidade_id
(opcional)
numeric Identificação da especialidade
canal_id
(opcional)
numeric Identificação do canal
procedimento_id
(opcional)
numeric Identificação do procedimento

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Disponibilidade de horários

Exemplo Request

GET https://api.feegow.com.br/api/appoints/available-schedule
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
    "tipo": "P",
    "procedimento_id": 5,
    "unidade_id": 0,
    "data_start": "08-08-2018",
    "data_end": "10-08-2018"
}

Exemplo Resposta

{
    "success": true,
    "content": {
        "profissional_id": {
            "1": {
                "local_id": [
                    {
                        "2018-08-10": [
                            "08:00:00",
                            "08:30:00",
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00",
                            "11:30:00",
                            "12:00:00"
                        ],
                        "2018-08-17": [
                            "08:00:00",
                            "08:30:00",
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00",
                            "11:30:00",
                            "12:00:00"
                        ],
                        "2018-08-24": [
                            "08:00:00",
                            "08:30:00",
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00",
                            "11:30:00",
                            "12:00:00"
                        ],
                        "2018-08-11": [
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00",
                            "11:30:00"
                        ],
                        "2018-08-18": [
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00",
                            "11:30:00"
                        ],
                        "2018-08-25": [
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00",
                            "11:30:00"
                        ]
                    }
                ]
            },
            "39": {
                "local_id": {
                    "0": {
                        "2018-08-17": [
                            "21:00:00",
                            "21:30:00",
                            "22:00:00"
                        ],
                        "2018-08-10": [
                            "15:00:00",
                            "15:30:00",
                            "16:00:00",
                            "16:30:00",
                            "17:00:00",
                            "17:30:00",
                            "18:00:00"
                        ],
                        "2018-08-24": [
                            "15:00:00",
                            "15:30:00",
                            "16:00:00",
                            "16:30:00",
                            "17:00:00",
                            "17:30:00",
                            "18:00:00"
                        ]
                    },
                    "15": {
                        "2018-08-11": [
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00"
                        ],
                        "2018-08-18": [
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00"
                        ],
                        "2018-08-25": [
                            "09:00:00",
                            "09:30:00",
                            "10:00:00",
                            "10:30:00",
                            "11:00:00"
                        ]
                    }
                }
            }
        }
    }
}

GET /appoints/available-schedule

Lista todos os horários disponíveis para uma especialidade ou procedimento.

Pode ser filtrado por unidade e profissional, possui um período de data para pesquisa.

Parâmetros

Parâmetro Tipo Descrição
tipo numeric E = Especialidade
P = Procedimento
especialidade_id
caso tipo = E
numeric Identificação da especialidade
procedimento_id
caso tipo = P
numeric Identificação do procedimento
data_start date Listar a partir dessa data
dd-mm-YYYY
data_end date Limitar consulta até essa data
dd-mm-YYYY
unidade_id numeric Identificação da unidade
profissional_id
(opcional)
numeric Identificação do profissional

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida

Criar novo agendamento

Exemplo Request

POST https://api.feegow.com.br/api/appoints/new-appoint
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
	"local_id": 0,
	"paciente_id": 5,
	"profissional_id": 10,
	"procedimento_id": 5,
	"especialidade_id": 95,
	"data": "08-08-2018",
	"horario": "15:00:00",
	"valor": 550,
	"plano": 1,
	"canal_id": 5
}

Exemplo Resposta

{
    "success": true,
    "content": {
        "agendamento_id": 43
    }
}

POST /appoints/new-appoint

Cria um novo agendamento.

Parâmetros

Parâmetro Tipo Descrição
paciente_id numeric Identificação do paciente
data date Data do agendamento
dd-mm-YYYY
hora hour Horário do agendamento
HH:MM:SS - Formato 24hrs
procedimento_id numeric Identificação do procedimento
especialidade_id numeric Identificação da especialidade
local_id numeric Identificação do local
valor numeric Valor do agendamento
centavos
plano numeric 0 = Sem convênio
1 = Com convênio
convenio_id
(caso plano = 1)
numeric Identificação do convênio
profissional_id numeric Identificação do profissional
canal_id
(opcional)
numeric Identificação do profissional

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida
409 erro Paciente não encontrado
Horário ocupado

Cancelar agendamento

Exemplo Request

POST https://api.feegow.com.br/api/appoints/cancel-appoint
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
	"agendamento_id": 41,
	"motivo_id": 1,
	"obs" : "Paciente tinha uma reunião marcada."
}

Exemplo Resposta

{
    "success": true,
    "content": "Agendamento cancelado"
}

POST /appoints/cancel-appoint

Cancela um agendamento existente.

Parâmetros

Parâmetro Tipo Descrição
agendamento_id numeric Identificação do paciente
motivo_id
numeric ID Motivo do cancelamento
obs
(opcional)
string Observação do cancelamento

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida
409 erro Agendamento não existe

Remarcar agendamento

Exemplo Request

POST https://api.feegow.com.br/api/appoints/reschedule
Host: api.feegow.com.br
Content-Type: application/json
x-access-token: "SEUTOKEN"

Parâmetros

{
	"agendamento_id": 42,
	"motivo_id": 1,
	"data": "15-08-2018",
	"horario": "19:00:00",
	"obs": "Paciente tinha uma reunião marcada"
}

Exemplo Resposta

{
    "success": true,
    "content": "Agendamento cancelado"
}

POST /appoints/reschedule

Remarca um agendamento existente.

Parâmetros

Parâmetro Tipo Descrição
agendamento_id numeric Identificação do paciente
motivo_id numeric ID Motivo reagendamento
obs
(opcional)
string Observação do reagendamento
horario hour Novo horario do agendamento
HH:MM:SS 24hrs
data date Nova data do agendamento
DD-MM-YYYY

Respostas

Código Tipo Descrição
200 sucesso Operação bem sucedida
409 erro Agendamento não existe

Erros

Exemplo Error 409

{
    "success": false,
    "content": "String do erro"
}

Exemplo Error 422

{
    "paciente_id": [
        "validation.required"
    ]
}

Respostas

Código Tipo Descrição
422 erro Input inválido
409 erro Conflito interno, específico para cada método
401 erro Chave da API não está definida no header
403 erro Chave da API inativa