GC T007 - Especificacao Do Web Service Completo - PontoWEB

Especificação do Web Service
Completo - PontoWEB
Especificação do Web Service GC T007/31
Completo Público
Ahgora PontoWEB
SUMÁRIO
ESPECIFICAÇÃO DO WEB SERVICE 3
Sobre o Web Service 3
Definição do Serviço de Exportação de Batidas - obterBatidas 3
XML de Requisição 4
XML de Resposta 4
Definição do Serviço de Sincronização de Funcionários - sincFuncionarios 6
XML de Resposta 12
Definição do Serviço de Obtenção de Resultados - obterResultados 13
XML de Resposta 16
Definição do Serviço de Inserção de Escalas - insereEscalaFuncionarios 18
XML de Resposta 19
Definição do Serviço de Gerenciamento de Afastamentos - sincAfastamentos 20
XML de Resposta 22
XML de Resposta com erro 22
Definição do Serviço de Exportação de Funcionários - obterFuncionarios 24
XML de Resposta 26
Definição do Serviço de Exportação de Status de Equipamentos - obterStatusEquipamentos 27
XML de Resposta 28
Definição do Serviço de Exportação de Afastamentos - obterAfastamentos 29
XML de Resposta 30
Definição do Serviço de Importação de Centro de Custo - sincCentroCusto 32
XML de Resposta 33
Definição do Serviço de Sincronização de Usuários - sincUsuarios 34
XML de Resposta 35
XML de Resposta 36
Definição do Serviço de Exportação de Usuários - obterUsuarios 37
XML de Resposta 38
Definição do Serviço de Obtenção de Escalas e Jornadas dos Funcionários -
Matriz Florianópolis Filial São Paulo

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
ahgora.com.br - contato@ahgora.com.br - Rev. 31 -23/04/2021
Este documento segue as Políticas e Normas de Segurança da Informação da Ahgora. O seu compartilhamento está sujeito a classificação de nível de confidencialidade
atribuída.
2
Completo Público
Ahgora PontoWEB
obterEscalaJornadaFuncionarios 39
XML de Resposta 40
Definição do Serviço para cadastro de CNPJ/CPF da empresa - sincCadastrosNacionais 42
XML de Resposta 43
1. ESPECIFICAÇÃO DO WEB SERVICE
1.1. Sobre o Web Service
O PontoWEB permite a troca de informações com aplicações de terceiros através de um Web

Service que utiliza o padrão SOAP/1.1. O SOAP (Simple Object Access Protocol) é um protocolo para troca
de dados entre sistemas heterogêneos. Ele faz uso das tecnologias XML e HTTP, sendo independente de
plataforma ou linguagem de programação.
A empresa usuária do PontoWEB é responsável pelo desenvolvimento de um software (ou pela

implementação deste recursos em seu sistema legado), denominado cliente web service, que se conectará
ao web service da Ahgora, executando os serviços disponíveis pela interface. Este desenvolvimento pode
ser realizado em qualquer plataforma e com qualquer linguagem de programação.
1.2. Definição do Serviço de Exportação de Batidas - obterBatidas
O PontoWEB permite a exportação das batidas coletadas (registros de ponto) pelo serviço SOAP
obterBatidas:
Seguem os dados para acesso ao serviço de exportação de batidas:
● Serviço: obterBatidas
● Local: https://www.ahgora.com.br/ws/pontoweb.php
● WSDL: https://www.ahgora.com.br/ws/pontoweb.php?wsdl
Parâmetros de Chamada:
Parâmetro Tipo Obr Conteúdo
Chave de identificação da empresa (obtida a partir do PontoWEB, na tela

empresa string S
“Configurações”, aba “Web Service”, botão “Gerar nova chave SOAP”)
datai date S Data de início da pesquisa dos registros a serem recebidos (DDMMYYYY)
dataf date S Data de fim da pesquisa dos registros a serem recebidos (DDMMYYYY)

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
3
Completo Público
Ahgora PontoWEB
nrep_filtro string Filtro pelo identificador do equipamentoF
Menor nsr da batida a retornar. Caso utilizado em conjunto com o atributo

nsr int
“nrep_filtro”, permite que datai e dataf não sejam especificadas.
pis string Filtro opcional pelo PIS do funcionário
Conteúdo de Retorno (array de elementos de tipo complexo, contendo os seguintes atributos):
Parâmetro Tipo Conteúdo
NSR string Número de sequência do registro no relógio ponto
NREP string Número serial do relógio
PIS string PIS do funcionário
data string Data da batida (DDMMYYYY)
hora string Hora da batida (HHMM)
Informação da latitude onde o registro ocorreu. Caso o dispositivo não

latitude string informe a informação, o campo não será gerado. Ele pode vir apenas 1 vez
por registro.
Informação da longitude onde o registro ocorreu. Caso o dispositivo não

longitude string informe a informação, o campo não será gerado. Ele pode vir apenas 1 vez
por registro.
Seguem exemplos para o XML utilizado para a requisição das batidas e para a respectiva resposta,
contendo as batidas solicitadas (sem o envelope SOAP):
XML de Requisição
<empresa>99999999999999999999999999999999</empresa>
<datai>01/01/2012</datai>
<dataf>03/01/2012</dataf>
<nrep_filtro>00010000300000011</nrep_filtro>
<nsr>0999829</nsr>
XML de Resposta
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.ahgora.com.br/ws">

<SOAP-ENV:Body>
<ns1:obterBatidasResponse>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
4
Completo Público
Ahgora PontoWEB
<Batidas>
<DadosBatida>
<NSR>000010482</NSR>
<NREP>00010000300000011</NREP>
<PIS>8888888888</PIS>
<Data>31122014</Data>
<Hora>0814</Hora>
<Latitude>-29.71041602</Latitude>
<Longitude>-51.13806059</Longitude>
</DadosBatida>
<DadosBatida>
<NSR>000010488</NSR>
<NREP>00010000300000011</NREP>
<PIS>99999999999</PIS>
<Data>31122014</Data>
<Hora>1209</Hora>
<Latitude>-29.71041602</Latitude>
<Longitude>-51.13806059</Longitude>
</DadosBatida>
</Batidas>
</ns1:obterBatidasResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
5
Completo Público
Ahgora PontoWEB
1.3. Definição do Serviço de Sincronização de Funcionários -

sincFuncionarios
● Serviço: sincFuncionarios
Chave de identificação da empresa (obtida a partir do PontoWEB, na tela

empresa string S
“Configurações”, aba “Web Service”, botão “Gerar nova chave SOAP”)
Lista com os funcionários a serem adicionados, ou alterados. Cada

funcionários array
funcionário deve ter o formato apresentado na tabela Funcionários
Funcionários (array de elementos de tipo complexo, contendo os seguintes atributos):
matricula string S Matrícula do funcionário
pis string S PIS do funcionário
nome string S Nome do funcionário
codBarras string Código de barras do crachá
biometria string Dados da biometria
Senha para acesso do colaborador.

Se este campo estiver preenchido e o “passwdREP”
vazio, esta senha será válida para registro via teclado
passwd string
do equipamento, cliente windows e acesso ao portal do
colaborador. Caso seja utilizado para registro de ponto
nos equipamentos, utilize senha numérica.
Senha para ponto REP e Windows. Utilize senha

passwdREP int numérica. Caso deseje desconsiderar este campo no
registro de ponto, envie (-1).
Lista de strings com as localizações do funcionário.

Nota: quando enviado apenas 1 único elemento,
localizacoes string[]
poderão ser enviadas múltiplas localizações separadas
por pipe (|)
dataAdmissao string S Data em que o funcionário foi admitido (DDMMAAAA)

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
6
Completo Público
Ahgora PontoWEB
Data em que o funcionário foi demitido (vazio para

dataDemissao string
funcionários ativos) (DDMMAAAA)
ctps string Código CTPS do funcionário
mifare string Cartão mifare associado ao funcionário
cargo string Título do cargo
departamento string Departamento do funcionário
sexo string Gênero do funcionário (M ou F)
email string E-mail do funcionário
cpf string CPF do funcionário
rg string Carteira de Identidade do funcionário (RG)
cnpj string CNPJ da filial que o funcionário está alocado
centroCusto string Código do centro de custo
Regime de trabalho. Uma das opções:

- CLT
- estatutario
- estagiario
- temporario
- rda
- comissionado
- terceirizado
regimeTrabalho string
- menoraprendiz
- intermitente
- horista
- pensaovitalicia
- folhaconfidencial
- autonomo
- conselheiro
- pensaovitalicia
dataNascimento string Data de nascimento do funcionário (DDMMAAAA)
codInterno string Código interno do funcionário
bloqueado boolean Bloquear visualização das batidas pelo funcionário
msgAlertaAcesso string Mensagem de alerta na catraca para o acesso web
Código(s) para configurar perfil horário. Este parâmetro

suporta o envio de apenas códigos de tipos de perfis,
perfilHorario string ambos recebem 1,4 ou 8 códigos, os códigos devem ser
enviados separados pelo caractere “|” (Pipe) ex:
<perfilHorario
xsi:type="xsd:string">HOR00001|HOR00002|HOR00003|HOR00004|H

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
7
Completo Público
Ahgora PontoWEB
OR00005|HOR00006|HOR00007|HOR00009</perfilHorario>
Configuração de Horários
Quando enviado 1: Ativa “Único Perfil de Horário”, incluindo o código
do perfil enviado;
Quando enviado 2: Ativa “Perfis Diferentes por Tipo”, incluindo os
quatro códigos de perfis enviado;
Quando enviado 3: Ativa “Perfis Diferentes por Dia”, incluindo os oito
códigos de perfis enviados.
Motivo de bloqueio para bloquear funcionário no

motivoBloqueio string
AcessoWEB
Se passar true, esse funcionário não será integrado ao

naoIntegraEquipamentos Boolean
equipamento.
Valor do Benefício do colaborador, formatado ou não.

vr string (235,50 ou 23550). Este campo é opcional e para
clientes que utilizam o módulo financeiro.
login_saml string Nome de usuário para o SSO
A partir da escala padrão, obtém a última mudança na

lastChangeDefaultSchedule string
escala
1. se enviar o campo "bate_ponto" e

"data_troca_elegibilidade_ponto" (tem que enviar os
dois) vai verificar:
2. se o valor da string "bate_ponto" for "Ponto

Obrigatorio" (exatamente assim) e a data enviada em
"data_troca_elegibilidade_ponto" for válida
vai inserir no funcionário o histórico de ponto obrigatório
"true" para data enviada em
bate_ponto string
"data_troca_elegibilidade_ponto"
3. caso o valor da string "bate_ponto" for qualquer outra

coisa e a data enviada em
"data_troca_elegibilidade_ponto" for válida
vai inserir no funcionário o histórico de ponto obrigatório
"false" para data enviada em
"data_troca_elegibilidade_ponto"
data_troca_elegibilidade_po Data em que foi feita a última alteração da elegibilidade

string
nto de ponto.
Data no formato (AAAA-MM) que vai definir para qual

competência será aplicada o dado do campo “cnpj”, irá
criar histórico de alteração de cnpj para a data caso
dataCnpj string ainda não existe, substituir caso exista e caso não seja
enviado a competência atual (no momento da
integração será utilizada para registrar no histórico a
data da mudança do cnpj do funcionário)

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
8
Completo Público
Ahgora PontoWEB
telefone string Telefone
Define o custo hora do funcionário, utilizado para

custo_da_hora string
cálculos financeiros.
escala_padrao string Define a escala padrão para o funcionário
Se definida, apenas escalas com a mesma quantidade

carga_horaria number de carga horária poderá ser aplicada para este
funcionário
email_chefia string E-mail da chefia
matricula_chefia string Matrícula da chefia
nome_chefia string Nome da chefia
inicioFeriasMenorAprendiz string Início das férias do menor aprendiz
fimFeriasMenorAprendiz string Fim das férias do menor aprendiz
dataReintegracao string Data de reintegração (DDMMAAAA)
eventoReintegracao string Data de Evento de Reintegração (DDMMAAAA)
Necessário cadastrar o tipo de escala em

cadastros/editar/tipos_escalas, se tipo de escala
tipo_escala string
existir no cadastro da empresa, o tipo de escala será
aplicada ao funcionário
CamposPersonalizados : Indica a existência de campos personalizados que serão populados. Tem sua
aparência máxima de 1 vez.
Contempla os campos personalizados criados no cadastro do

CampoPersonalizado array
colaborador. Deve ser precedido de “campo” e “valor”. Não há limitação.
ID do campo personalizado. Obtido na interface de edição do mesmo no

campo string
PontoWEB.
valor string Valor do campo personalizado.
permissao_modulos : array
modulo string Tipo de módulo selecionado

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
9
Completo Público
Ahgora PontoWEB
modulo: array
produto para habilitar:. Valores possíveis:

ponto_web
batida_online
batida_mobile
produto string
timesheet
smartgate
rostering
vacations
“0” para desativar “1” para ativar, só vai ativar caso tenha licenças
valor string
disponíveis para o produto
financeiro : Indica os campos financeiros
Valor do salário do colaborador, formatado ou não. (2.245,50 ou

salario string 224550). Este campo é opcional e para clientes que utilizam o módulo
financeiro.
benefícios array Indica os campos de Benefícios
Número de funcionários recebidos que não existiam no sistema e, por isso,

inseridos int
foram inseridos
Número de funcionários recebidos que já existiam no sistema e, por isso,

alterados int
foram alterados
Número de funcionários recebidos com data de demissão e demitidos no

demitidos int
sistema
Lista com os erros ocorridos na importação. (Elemento aparece apenas

erros [string]
quando ocorrem erros)
XML de Requisição
<empresa xsi:type="xsd:string">99999999999999999999999999999999</empresa>
<funcionarios>
<funcionario>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
10
Completo Público
Ahgora PontoWEB
<matricula xsi:type="xsd:string">00000000</matricula>
<pis xsi:type="xsd:string">000000000000</pis>
<nome xsi:type="xsd:string">Nome do Funcionário 1</nome>
<codBarras xsi:type="xsd:string">00000000</codBarras>
<biometria xsi:type="xsd:string">...</biometria>
<passwd xsi:type="xsd:string">senha</passwd>
<passwdREP xsi:type="xsd:int">12345</passwdREP>
<localizacoes>Localização 01</localizacoes>
<localizacoes>Localização 02</localizacoes>
<dataAdmissao xsi:type="xsd:string">01012012</dataAdmissao>
<dataDemissao xsi:type="xsd:string"></dataDemissao>
<ctps xsi:type="xsd:string">01010101</ctps>
<mifare xsi:type="xsd:string">101,010,101</mifare>
<cargo xsi:type="xsd:string">Cargo 01</cargo>
<departamento xsi:type="xsd:string">Departamento 01</departamento>
<cnpj xsi:type="xsd:string">00.000.000/0001-01</cnpj>
<cpf xsi:type="xsd:string">351.086.434-46</cpf>
<dataNascimento xsi:type="xsd:string">01/01/2001</dataNascimento>
<sexo xsi:type="xsd:string">M</sexo>
<email xsi:type="xsd:string">func01@email.com</email>
<codInterno xsi:type="xsd:string">001</codInterno>
<dataNascimento xsi:type="xsd:string">31121990</dataNascimento>
<financeiro>
<salario>22222</salario>
<beneficios>
<vr>2150</vr>
</beneficios>
</financeiro>
<CamposPersonalizados>
<CampoPersonalizado>
<campo>5ab2a76de8628826168b4579</campo>
<valor>1030</valor>
</CampoPersonalizado>
<campo>5bb3da9e37eaeacb508444aa</campo>
<valor>1080</valor>
</CamposPersonalizados>
<login_saml>valor generico</login_saml>
<escala_padrao xsi:type="xsd:string">4x1</escala_padrao>
<carga_horaria xsi:type="xsd:string">40</carga_horaria>
<email_chefia xsi:type="xsd:string">nome@empresa.com.br</email_chefia>
<matricula_chefia xsi:type="xsd:string">00000000</matricula_chefia>
<nome_chefia xsi:type="xsd:string">nome chefia</nome_chefia>
<inicioFeriasMenorAprendiz xsi:type="xsd:string">12052021</inicioFeriasMenorAprendiz>
<fimFeriasMenorAprendiz xsi:type="xsd:string">12062021</fimFeriasMenorAprendiz>
<dataReintegracao xsi:type="xsd:string">17042021</dataReintegracao>
<eventoReintegracao xsi:type="xsd:string">19042021</eventoReintegracao>
<permissao_modulos xsi:type="xsd:string">batida_online</permissao_modulos>
<data_troca_elegibilidade_ponto xsi:type="xsd:string"></data_troca_elegibilidade_ponto>
<bate_ponto xsi:type="xsd:string">false</bate_ponto>
<lastChangeDefaultSchedule xsi:type="xsd:string">20042021</lastChangeDefaultSchedule>
</funcionario>
<funcionario>
<matricula xsi:type="xsd:string">11111111</matricula>
<pis xsi:type="xsd:string">111111111111</pis>
<nome xsi:type="xsd:string">Nome do Funcionário 2</nome>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
11
Completo Público
Ahgora PontoWEB
<codBarras xsi:type="xsd:string">11111111</codBarras>
<biometria xsi:type="xsd:string">...</biometria>
<passwd xsi:type="xsd:string">1111111111</passwd>
<localizacoes SOAP-ENC:arrayType="xsd:string[2]" xsi:type="xsd:string[]">
<item xsi:type="xsd:string">Localização 03</item>
<item xsi:type="xsd:string">Localização 05</item>
</localizacoes>
<dataAdmissao xsi:type="xsd:string">31012012</dataAdmissao>
<dataDemissao xsi:type="xsd:string">31052012</dataDemissao>
<ctps xsi:type="xsd:string">02020202</ctps>
<mifare xsi:type="xsd:string">020,202,020</mifare>
<cargo xsi:type="xsd:string">Cargo 01</cargo>
<departamento xsi:type="xsd:string">Departamento 02</departamento>
<cnpj xsi:type="xsd:string">11.111.111/0001-01</cnpj>
<cpf xsi:type="xsd:string">258.575.545-27</cpf>
<dataNascimento xsi:type="xsd:string">02/02/2002</dataNascimento>
<sexo xsi:type="xsd:string">F</sexo>
<email xsi:type="xsd:string">func02@email.com</email>
<bloqueado xsi:type="xsd:boolean">true</bloqueado>
<codInterno xsi:type="xsd:string">888888</codInterno>
<financeiro>
<salario>32222</salario>
<beneficios>
<vr>1150</vr>
</beneficios>
</financeiro>
<CamposPersonalizados>
<campo>5ab2a76de8628826168b4579</campo>
<valor>2030</valor>
<campo>5bb3da9e37eaeacb508444aa</campo>
<valor>4080</valor>
</CamposPersonalizados>
</funcionario>
</funcionarios>
XML de Resposta
<totais>
<inseridos>2</inseridos>
<alterados>2</alterados>
<demitidos>3</demitidos>
<erros>Matrícula [11111111]: Pis Inválido</erros>
</totais>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
12
Completo Público
Ahgora PontoWEB
1.4. Definição do Serviço de Obtenção de Resultados - obterResultados
● Serviço: obterResultados
Chave de identificação da empresa (obtida a partir do PontoWEB, na

empresa string S tela “Configurações”, aba “Web Service”, botão “Gerar nova chave
SOAP”)
matricula string S Matrícula do funcionário a ser pesquisado
Data inicial da consulta no formato (DDMMYYYY)

datai string S
Ver OBS do campo ano.
Data final da consulta no formato (DDMMYYYY)

dataf string S
Pode ser enviado no lugar de datai e dataf, junto com o ano, para
mes string consultar uma competência no formato (MM)
Pode ser enviado no lugar de datai e dataf, junto com o mes, para
consultar uma competência no formato (YYYY)
ano string
OBS: Caso sejam enviados os 4 parâmetros (datai, dataf, mes e ano)
a prioridade é do datai e dataf.
Lista de parâmetros personalizados que são definidos por nome e

valor.
Hoje possuem dois parâmetros que podem ser utilizados:
● periodo_aberto
Esse parâmetro do tipo booleano permite realizar a pesquisa
pelo período estipulado nos campos datai e dataf contemplando o dia,
mês e ano, quando o valor informado for true. Caso false, será
pesquisado o mês contábil estipulado nos campos datai e dataf ou
mes e ano, contemplando apenas mês e ano.
opcoes array
● apuracao_diaria
Esse parâmetro do tipo booleano traz junto aos totalizadores
mensais, a apuração diária.
● troca_matricula_codigo_interno
Esse parâmetro faz o sistema substituir o campo
matrícula, na busca e no resultado pelo campo código
interno.

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
13
Completo Público
Ahgora PontoWEB
Tempo máximo de cache do processamento da última alteração na

max_age int apuração, em segundos. Exemplo: com o valor default, as alterações
hoje incluídas não serão processadas. Default: 86400 (24 horas)
opcoes (array de elementos de tipo complexo denominado opções, contendo os seguintes atributos):
opcao array
● periodo_aberto
nome string ● apuracao_diaria
● troca_matricula_codigo_interno
valor string true ou false
resultados array Lista dos resultados apurados para o funcionário
diarios array Lista dos dias apurados de acordo com o filtro para cadas funcionário
Mensagem de erro da consulta
Erros:
- “Hash empresa não encontrada"
erros string - "Matrícula é um campo obrigatório"
- "Matrícula ou código interno não encontrada"
- "datai e dataf é obrigatório para período aberto"
- "é obrigatório informar [data_inicial e data_final(DDMMYYYY)] ou
[ano(YYYY) e mês(MM)]"
Resultado (array de elementos de tipo complexo denominado Resultados, contendo os seguintes atributos):
matricula string Matrícula do funcionário
cod_contabil string Código contábil do evento
nome string Nome do evento
valor string Total de horas apurado no evento
Diario (array de elementos de tipo complexo denominado Diários, contendo os seguintes atributos):

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
14
Completo Público
Ahgora PontoWEB
dia string Dia apurado do funcionário
batidas string Batidas realizadas no dia
batida array
hora string Hora da Batida
data_registro string Data real da batida
Quando a batida for incluída

motivo string através de justificativa, será
apresentado o motivo.
Lista com os totalizadores diários

de cada funcionário, contendo os
resultados array
parâmetros de resposta nome e
valor
XML de Requisição
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="https://www.ahgora.com.br/ws">

<soapenv:Header/>
<soapenv:Body>
<ws:obterResultados>
<empresa>99999999999999999999999999999999</empresa>
<matricula>9999999</matricula>
<datai>01012014</datai>
<dataf>31012014</dataf>
<mes>01</mes>
<ano>2014</ano>
<opcoes>
<Opcao>
<nome>periodo_aberto</nome>
<valor>false</valor>
</Opcao>
<Opcao>
<nome>apuracao_diaria</nome>
<valor>true</valor>
</Opcao>
<Opcao>
<nome>troca_matricula_codigo_interno</nome>
<valor>false</valor>
</Opcao>
</opcoes>
<max_age>86400</max_age>
</ws:obterResultados>
</soapenv:Body>
</soapenv:Envelope>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
15
Completo Público
Ahgora PontoWEB
XML de Resposta
● Com parâmetro “apuracao_diaria” com o valor “false”

<SOAP-ENV:Body>
<ns1:obterResultadosResponse>
<Resultados>
<Resultado>
<cod_contabil>9999</cod_contabil>
<nome>Horas Trabalhadas</nome>
<valor>999:99</valor>
</Resultado>
<Resultado>
<cod_contabil></cod_contabil>
<nome>Hora a menos</nome>
<valor>-99:99</valor>
</Resultado>
</Resultados>
<Diarios/>
</ns1:obterResultadosResponse>
</SOAP-ENV:Body>
● Com parâmetro “apuracao_diaria” com o valor “true”

<SOAP-ENV:Body>
<ns1:obterResultadosResponse>
<Resultados>
<Resultado>
<cod_contabil>9999</cod_contabil>
</Resultado>
<Resultado>
<cod_contabil></cod_contabil>
<nome>Hora a menos</nome>
<valor>-99:99</valor>
</Resultado>
</Resultados>
<Diarios/>
<Diario>
<dia>9999-99-99</dia>
<Batidas>
<Batida>
<Hora>99:99</Hora>
<Motivo>Motivo da Justificativa</Motivo>
<Data_Registro>9999-99-99</Data_Registro>
</Batida>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
16
Completo Público
Ahgora PontoWEB
<Batida>
<Hora>99:99</Hora>
<Motivo>Motivo da Justificativa</Motivo>
<Data_Registro>9999-99-99</Data_Registro>
</Batida>
</Batidas>
<Resultados>
<Resultado>
</Resultado>
<Resultado>
<nome>Expediente</nome>
</Resultado>
</Resultados>
</Diario>
<Diario>
<dia>9999-99-99</dia>
<Batidas>
<Batida>
<Hora>99:99</Hora>
<motivo>Motivo da Justificativa</motivo>
</Batida>
<Batida>
<Hora>99:99</Hora>
<motivo>Motivo da Justificativa</motivo>
</Batida>
</Batidas>
<Resultados>
<Resultado>
</Resultado>
<Resultado>
<nome>Expediente</nome>
</Resultado>
</Resultados>
</Diario>
</Diarios>
</ns1:obterResultadosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
17
Completo Público
Ahgora PontoWEB
1.5. Definição do Serviço de Inserção de Escalas -

insereEscalaFuncionarios
Este serviço permite atribuir escalas e jornadas, cadastrados no PontoWEB, aos colaboradores.
● Serviço: insereEscalaFuncionarios

empresa string S tela “Configurações”, aba “Web Service”, botão “Gerar nova chave
SOAP”)
matricula string S Matrícula do funcionário a ser pesquisado
datai string S Data inicial da consulta no formato (YYYYMMDD)
dataf string Data final da consulta no formato (YYYYMMDD)
nome_escala string S Nome da escala cadastrada a ser inserida no funcionário
inicio_jornada string S Dia da jornada a ser inserida como início (caso escala não semanal)
Contém um complexo com as

error array matrículas em que não foi feita a
inserção
Contém um complexo com as

success array matrículas em que a inserção foi
concluída com sucesso
Seguem exemplos para o XML utilizado para a inserção das escalas em funcionários:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:insereEscalaFuncionarios>
<empresa>99999999999999999999999999999999</empresa>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
18
Completo Público
Ahgora PontoWEB
<FuncionariosEscalas>
<FuncionarioEscala>
<datai>2015-02-05</datai>
<dataf>2015-02-09</dataf>
<nome_escala>Semanal - Falta</nome_escala>
<inicio_jornada>2</inicio_jornada>
</FuncionarioEscala>
<FuncionarioEscala>
<FuncionarioEscala>
</FuncionariosEscalas>
</ws:insereEscalaFuncionarios>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:insereEscalaFuncionariosResponse>
<Results>
<ns1:Results>
<success>Matricula [002]: Sucesso ao aplicar escala</success>
<success>Matricula [004]: Sucesso ao aplicar escala</success>
<success>Matricula [005]: Escala nao encontrada</success>
</ns1:Results>
</Results>
</ns1:insereEscalaFuncionariosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
19
Completo Público
Ahgora PontoWEB
1.6. Definição do Serviço de Gerenciamento de Afastamentos -

sincAfastamentos
● Serviço: sincAfastamentos
Chave de identificação da empresa (obtida a partir do PontoWEB,

empresa string S na tela “Configurações”, aba “Web Service”, botão “Gerar nova
chave SOAP”)
afastamentos afastamento[] Lista de afastamentos a serem atualizados
Afastamento (array de elementos de tipo complexo, contendo os seguintes atributos):
Código do afastamento cadastrado no PontoWEB. Deve ser

cod string S
deixado em branco para inserções
Código único de afastamento no cliente. Este código é

armazenado para servir de chave para alterações no
cod_interno string
afastamento. Para este comportamento, é necessário ativar no
ADMIM (Ahgora). Caso contrário, o campo é ignorado.
As atribuições deste campo foram para “cod_interno”.

cod_unico string Código único afastamento no cliente. Este código é armazenado
para servir de chave para alterações no afastamento
Código do motivo do afastamento conforme cadastrado no

motivo string S
PontoWEB
tratar_como string Nome do tipo de hora a ser utilizado caso existam batidas no dia
Valor booleano sobre abonar ou não as faltas no afastamento.

nao_abonar_falta string
Utilizar ‘1’ para ativar
Valor booleano sobre descontar DSR ou não no caso de faltas

nao_descontar_dsr string
durante este afastamento. Utilizar ‘1’ para ativar
Valor booleano sobre tratar o período do afastamento como dia.

tratar_como_dia string
Valor booleano sobre bloquear o funcionário durante o

bloqueio_acesso string
afastamento. Depende da utilização do módulo de acesso.

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
20
Completo Público
Ahgora PontoWEB
Matrícula dos funcionários serão afastados. Permite múltiplos

matricula string S
elementos. Obrigatório para novos afastamentos
AAAA-MM-DDTHH:MM ou AAAA-MM-DD. Data e hora de início

inicio datetime S do afastamento. Obrigatório para novos afastamentos.
Ao indicar apenas a data ele considera 00:00
AAAA-MM-DDTHH:MM ou AAAA-MM-DD. Data e hora de início

do afastamento. Obrigatório para novos afastamentos.
Ao indicar apenas a data ele considera 24:00.
fim datetime S Exemplos:
<fim>2019-10-15T00:00</fim> Corresponde a 14/10/2019

<fim>2019-10-15T24:00</fim> Corresponde a 15/10/2019
<fim>2019-10-15</fim> Corresponde a 15/10/2019
remover string Envie o texto REMOVER para remover o afastamento
Valor booleano para utilizar o ajuste de hora pela jornada. Utilizar

hora_pela_jornada string
‘1’ para ativar
Valor booleano sobre ignorar o período de bloqueio na hora de

alterar. Utilizar ‘1’ para ativar. CUIDADO: com essa flag ativa
ignora_bloqueio string
você pode estar alterando os dados de períodos que já foram
fechados e aprovados pelo gestor.
cod string Código do afastamento cadastrado no PontoWEB.
cod_interno string Código único de afastamento no cliente. (Quando enviado na chamada)
error string Mensagem do erro encontrado. (quando há algum erro)
Contém um tipo complexo com os mesmos atributos do tipo afastamento

origem afastamento[]
enviado.
Seguem exemplos para o XML utilizado para a inserção dos afastamentos em funcionários:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:sincAfastamentos>
<empresa>99999999999999999999999999999999</empresa>
<afastamentos>
<Afastamento>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
21
Completo Público
Ahgora PontoWEB
<cod></cod>
<cod_interno>1000</cod_interno>
<motivo>11</motivo>
<tratar_como>50%</tratar_como>
<nao_abonar_falta>1</nao_abonar_falta>
<nao_descontar_dsr>1</nao_descontar_dsr>
<tratar_como_dia>1</tratar_como_dia>
<hora_pela_jornada>1</hora_pela_jornada>
<inicio>2015-01-05</inicio>
<fim>2015-01-05</fim>
</Afastamento>
</afastamentos>
</ws:sincAfastamentos>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:sincAfastamentosResponse>
<totais>
<AfastamentoResult>
<cod>00210</cod>
<origem>
<motivo>11</motivo>
<tratar_como>50%</tratar_como>
<hora_pela_jornada>1</hora_pela_jornada>
<fim>2015-01-05</fim>
</origem>
</AfastamentoResult>
</totais>
</ns1:sincAfastamentosResponse>
</SOAP-ENV:Body>
XML de Resposta com erro

<SOAP-ENV:Body>
<ns1:sincAfastamentosResponse>
<totais>
<AfastamentoResult>
<cod/>
<cod_interno></cod_interno>
<erro>O afastamento possui intersecção com outro já cadastrado.</erro>
<origem>
<cod></cod>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
22
Completo Público
Ahgora PontoWEB
<motivo>11</motivo>
<hora_pela_jornada></hora_pela_jornada>
<fim>2015-01-05</fim>
<remover></remover>
<ignora_bloqueio></ignora_bloqueio>
</origem>
</AfastamentoResult>
</totais>
</ns1:sincAfastamentosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
23
Completo Público
Ahgora PontoWEB
1.7. Definição do Serviço de Exportação de Funcionários -

obterFuncionarios
Este serviço permite consultar os funcionários cadastrados na empresa. Os parâmetros de entrada

(com exceção do hash) são opcionais e caracterizam filtros para a consulta.
● Serviço: obterFuncionarios

hash string S na tela “Configurações”, aba “Web Service”, botão “Gerar nova
chave SOAP”)
pis string PIS do funcionário
nome string Nome do funcionário
codbarra string Código de barras do crachá do funcionário
Mostra apenas funcionários sem biometria (true / false)

biometria string
Deixando o campo vazio será tratado como false
dt_admissao string Data de admissão do funcionário (DD/MM/YYYY ou DDMMYYYY)
dt_demissao string Data de demissão do funcionário (DD/MM/YYYY ou DDMMYYYY)
cargo string Cargo do funcionário
localizacao string Localização do funcionário
Mostra apenas os funcionários demitidos (true / false)

mostrar_demitidos boolean
Deixando o campo vazio será tratado como false
login_saml string Nome de usuário para SSO
Funcionários (array de elementos de tipo complexo, contendo os seguintes atributos):

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
24
Completo Público
Ahgora PontoWEB
pis string PIS do funcionário
nome string Nome do funcionário
codBarras string Código de barras do crachá do funcionário
biometria string Dados da biometria
localizacoes string[] Lista de strings com as localizações do funcionário
dataAdmissao string Data em que o funcionário foi admitido (DDMMAAAA)
Data em que o funcionário foi demitido (vazio para funcionários

dataDemissao string
ativos) (DDMMAAAA)
mifare string Cartão mifare associado ao funcionário
cargo string Título do cargo
cnpj string CNPJ da filial em que o funcionário está alocado
cpf string CPF do funcionário
dataNascimento string Data de nascimento do funcionário (YYYYMMDD)
sexo string Gênero do funcionário (M ou F)
email string E-mail do funcionário
regimeTrabalho Regime de trabalho.
centroCusto string Código do centro de custo
rg string Carteira de Identidade do funcionário (RG)
Seguem exemplos para o XML utilizado para exportação de funcionários:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:obterFuncionarios>
<hash>99999999999999999999999999999999</hash>
<pis>999999999999</pis>
<nome>Nome do Funcionario</nome>
<codbarra>999999</codbarra>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
25
Completo Público
Ahgora PontoWEB
<biometria>true</biometria>
<dt_admissao>00/00/0000</dt_admissao>
<dt_demissao>00/00/0000</dt_demissao>
<cargo>Cargo</cargo>
<departamento>Departamento</departamento>
<localizacao>Local</localizacao>
<mostrar_demitidos>false</mostrar_demitidos>
</ws:obterFuncionarios>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.ahgora.com.br/ws"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<ns1:obterFuncionariosResponse>
<funcionarios>
<funcionario>
<pis>999999999999</pis>
<nome>Nome do Funcionario</nome>
<codBarras>999999</codBarras>
<biometria>Dados da Biometria</biometria>
<localizacoes>
<xsd:string>Local 1</xsd:string>
<xsd:string>Local 2</xsd:string>
</localizacoes>
<dataAdmissao>0000-00-00</dataAdmissao>
<mifare>999999</mifare>
<cargo>Cargo</cargo>
<departamento>Departamento</departamento>
<cnpj>99999999999999</cnpj>
<cpf>99999999999</cpf>
<dataNascimento>0000-00-00</dataNascimento>
<sexo>M</sexo>
<email>email@host.com.br</email>
<regimeTrabalho>CLT</regimeTrabalho>
<centroCusto>554d157c574729as456a5s6b</centroCusto>
<rg>9999999</rg>
</funcionario>
</funcionarios>
</ns1:obterFuncionariosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
26
Completo Público
Ahgora PontoWEB
1.8. Definição do Serviço de Exportação de Status de Equipamentos -

obterStatusEquipamentos
● Serviço: obterStatusEquipamentos

hash string S tela “Configurações”, aba “Web Service”, botão “Gerar nova
chave SOAP”)
Mostra apenas os REPs ocultos (true / false). Deixando o campo

mostrar_ocultos boolean
vazio será tratado como false
Modelos de REPs Ex: [ Ah-10 cb, Ah-10 cbm, Ah-10 c, Ah-07, Ah-10
modelo string
lite, Ah-10 e, Demo, Acesso ]
Status do REP
Ex: [Ok, Nível crítico de papel, Compartimento de impressora aberto,
Compartimento de impressora aberto, Sem comunicação há mais de
status string 5 minutos, Impressora sem papel, Falha de leitura no AFD, Falta
espaço na memória de trabalho, Falta espaço na memória de
registro, Há problemas na memória de registro, Desconectado, Porta
Aberta, Porta Fechada]
nome string Nome do REP
numero_serie string Número de série pertencente a um REP
Equipamentos (array de elementos de tipo complexo, contendo os seguintes atributos):
Status atual do REP

Ex: [Ok, Nível crítico de papel, Compartimento de impressora aberto,
Compartimento de impressora aberto, Sem comunicação há mais de 5
status string minutos, Impressora sem papel, Falha de leitura no AFD, Falta espaço
na memória de trabalho, Falta espaço na memória de registro, Há
problemas na memória de registro, Desconectado, Porta Aberta, Porta
Fechada ]
nome string Nome do REP
ultimo_ip string Último IP utilizado pelo REP

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
27
Completo Público
Ahgora PontoWEB
Modelo do REP
modelo string Ex: [ Ah-10 cb, Ah-10 cbm, Ah-10 c, Ah-07, Ah-10 lite, Ah-10 e, Demo,
Acesso ]
nsr string Último Número Sequencial de Registro - NSR gerado
data_hora_ultimo_
string Data e hora da última conexão (DD/MM/YYYY HH:MM)
conexao
numero_serie string Número de série do equipamento
uso_atual_bobina string Porcentagem de utilização da bobina
Seguem exemplos para o XML utilizado para exportação de status de equipamentos:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:obterStatusEquipamentos>
<hash>999999999999999999999999999999</hash>
<mostrar_ocultos>false</mostrar_ocultos>
<modelo>Ah-10 lite</modelo>
<status>Desconectado</status>
<nome>Nome do REP</nome>
<numero_serie>AAAAAA-AA99999999</numero_serie>
</ws:obterStatusEquipamentos>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:obterStatusEquipamentosResponse>
<equipamentos>
<equipamento>
<status>Desconectado</status>
<nome>Nome do Equipamento</nome>
<ultimo_ip>192.168.0.1</ultimo_ip>
<modelo>Ah-10 lite</modelo>
<nsr>99999</nsr>
<data_hora_ultimo_conexao>00/00/0000 00:00</data_hora_ultimo_conexao>
<numero_serie>AAAAAA-AA99999999</numero_serie>
<uso_atual_bobina>99 %</uso_atual_bobina>
</equipamento>
</equipamentos>
</ns1:obterStatusEquipamentosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
28
Completo Público
Ahgora PontoWEB
1.9. Definição do Serviço de Exportação de Afastamentos -

obterAfastamentos
Este serviço permite consultar os afastamentos cadastrados na empresa. Os parâmetros de entrada

● Serviço: obterAfastamentos

hash string S tela “Configurações”, aba “Web Service”, botão “Gerar nova chave
SOAP”)
motivo string Motivo do afastamento
Data de início do afastamento (DDMMAAAA ou DD/MM/AAAA).

Condições:
- dt_inicio e dt_fim preenchidos: Serão apresentados todos

dt_inicio string os afastamentos iniciados com data igual ou superior a esta,
e finalizados até dt_fim;
- dt_inicio preenchida e dt_fim em branco ou não enviada:
Serão apresentados todos os afastamentos iniciados a partir
da data dt_inicio.
Data final do afastamento (DDMMAAAA ou DD/MM/AAAA).

Condições:
- dt_fim e dt_inicio preenchidos: Serão apresentados todos
os afastamentos iniciados com data igual ou superior a esta,
dt_fim string
e finalizados até dt_fim;
- dt_fim preenchida e dt_inicial em branco ou não enviada:
Serão apresentados todos os afastamentos finalizados a
partir da data dt_fim.
Data a partir da qual devem ser obtidas as atualizações (igual ou

dt_atualizacao string
superior a esta data. (AAAA-MM-DDTHH:MM ou AAAA-MM-DD)
Código do motivo do afastamento a ser buscado. A inserção do

cod_motivo string
campo motivo nos filtros dessa chamada invalida esse campo.
Afastamento (array de elementos de tipo complexo, contendo os seguintes atributos):

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
29
Completo Público
Ahgora PontoWEB
Código do afastamento cadastrado no PontoWEB. Deve ser deixado

cod string
em branco para inserções
Código do afastamento no cliente. Este código não é armazenado e

cod_interno string
apenas serve de ponte para o código do PontoWEB nas inserções
cod_motivo string Código do motivo do afastamento conforme cadastrado no PontoWEB
Descrição do motivo do afastamento conforme cadastrado no

motivo string
PontoWEB
tratar_como string Nome do tipo de hora a ser utilizado caso existam batidas no dia
Valor booleano sobre abonar ou não as faltas no afastamento. Utilizar

nao_abonar_falta string
‘1’ para ativar
Valor booleano sobre descontar DSR ou não no caso de faltas durante

nao_descontar_dsr string
este afastamento. Utilizar ‘1’ para ativar
Valor booleano sobre tratar o período do afastamento como dia. Utilizar

tratar_como_dia string
‘1’ para ativar
matricula string Matrícula do funcionário afastado
inicio datetime Data e hora de início do afastamento (AAAA-MM-DD HH:MM)
fim datetime Data e hora de início do afastamento (AAAA-MM-DD HH:MM)
Data e hora em que o afastamento foi atualizado pela última vez

dt_atualizacao string
(AAAA-MM-DD HH:MM)
Seguem exemplos para o XML utilizado para a obtenção dos afastamentos:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:obterAfastamentos>
<hash>99999999999999999999999999999999</hash>
<motivo>Atestado</motivo>
<dt_inicio>01012000</dt_inicio>
<dt_fim>01012000</dt_fim>
<cod_motivo>123</cod_motivo> (*Se existir o campo motivo, esse será ignorado.)
</ws:obterAfastamentos>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
30
Completo Público
Ahgora PontoWEB
<SOAP-ENV:Body>
<ns1:obterAfastamentosResponse>
<afastamentos>
<Afastamento>
<cod>00000</cod>
<cod_interno/>
<motivo>Atestado</motivo>
<cod_motivo>018</cod_motivo>
<tratar_como>opção tratar batidas como</tratar_como>
<inicio>2000-01-01 00:00</inicio>
<fim>2000-01-01 00:00</fim>
</Afastamento>
</afastamentos>
</ns1:obterAfastamentosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
31
Completo Público
Ahgora PontoWEB
1.10. Definição do Serviço de Importação de Centro de Custo -

sincCentroCusto
Este serviço fornece a possibilidade de importar ou sincronizar centros de custo individual e em

massa. Ele recebe um ou mais centros de custos, caso algum já exista mas esteja com nome diferente, ele
atualiza na base, se não existir ele cria, se já existir e não houver alterações retorna erro indicando a
existência do mesmo.
● Serviço: sincCentroCusto
Chave de identificação da empresa (obtida a partir do

empresa string S PontoWEB, na tela “Configurações”, aba “Web Service”, botão
“Gerar nova chave SOAP”)
CentrosCusto CentroCusto[] S Lista de centros de custo a serem importados
CentroCusto (array de elementos de tipo complexo, contendo os seguintes atributos):
codigo string S Código do Centro de custo a ser cadastrado no PontoWEB
nome string S Nome do centro de custo a ser cadastrado no PontoWEB
Resultado (array de elementos de tipo complexo, contendo os seguintes atributos):
error array Contém uma mensagem informando quantos centros não foram adicionados
success array Contém uma mensagem informando quantos centros foram adicionados
Seguem exemplos para o XML utilizado para a inserção de centros de custo:
XML de Requisição
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="https://localhost/ws">

<soapenv:Header/>
<soapenv:Body>
<ws:sincCentroCusto>
<CentrosCusto>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
32
Completo Público
Ahgora PontoWEB
<CentroCusto>
<nome xsi:type="xsd:string">Centro de Custo</nome>
<codigo xsi:type="xsd:string">11111111</codigo>
</CentroCusto>
</CentrosCusto>
</ws:sincCentroCusto>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta
<?xml version="1.0" encoding="UTF-8"?>

<SOAP-ENV:Body>
<ns1:sincCentroCustoResponse>
<CentrosCusto>
<sucesso>2 novos centros de custo inseridos.</sucesso>
<erros>campos "nome" e "codigo" são obrigatorios</erros>
</CentrosCusto>
</ns1:sincCentroCustoResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
33
Completo Público
Ahgora PontoWEB
1.11. Definição do Serviço de Sincronização de Usuários - sincUsuarios
Este serviço fornece a possibilidade de sincronizar usuários do Ahgora PontoWEB. Permite Incluir,
Alterar e Excluir usuários.
● Serviço: sincUsuarios

Usuarios Usuarios[] S Lista de usuários a serem importados
Usuarios (array de elementos de tipo complexo, contendo os seguintes atributos):
email string S E-mail do usuário a se cadastrado no PontoWEB
nome string N Nome do usuário a ser cadastrado no PontoWEB
perfil string S Perfil de acesso ao sistema a ser atribuído ao usuário.
perfilNovo string Perfil para alteração quando múltiplos perfis.
Lista de strings com as localizações do usuário. Nota: quando enviado

localizacao string[] apenas 1 único elemento, poderão ser enviadas múltiplas localizações
separadas por pipe (|)
remover string Envie o texto REMOVER para remover o usuário.
Usuarios Usuarios[] Lista de usuários importados
erros string[] Erros encontrados

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
34
Completo Público
Ahgora PontoWEB
erro string Erro encontrado
Seguem exemplos para o XML utilizado para a inserção de usuários:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:sincUsuarios>
<Usuarios>
<Usuario>
<email xsi:type="xsd:string">pedro.silva@xxxxxx.com.br</email>
<nome xsi:type="xsd:string">Pedro da Silva</nome>
<perfil xsi:type="xsd:string">Administrador</perfil>
<localizacao>Loc 1</localizacao>
<localizacao>Loc2</localizacao>
</Usuario>
</Usuarios>
</ws:sincUsuarios>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:sincUsuariosResponse>
<usuarios>
<usuario>
<emai>pedro.silva@xxxxxx.com.br</email>
<perfil>Administrador</perfil>
</usuario>
<erros>
<erro>pedro.silva@xxxxxx.com.brl: Mensagem de erro</erros>
</erros>
</usuarios>
</ns1:sincUsuariosResponse>
</SOAP-ENV:Body>
Seguem exemplos para o XML utilizado para a excluir de usuários:
XML de Requisição

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
35
Completo Público
Ahgora PontoWEB
<soapenv:Header/>
<soapenv:Body>
<ws:sincUsuarios>
<Usuarios>
<Usuario>
<email>pedro.silva@xxxxxx.com.br</email>
<remover>REMOVER</remover>
</Usuario>
</Usuarios>
</ws:sincUsuarios>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:sincUsuariosResponse>
<Usuarios>
<Usuario>
<emai>pedro.silva@xxxxxx.com.br</email>
</Usuario>
</Usuarios>
</ns1:sincUsuariosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
36
Completo Público
Ahgora PontoWEB
1.12. Definição do Serviço de Exportação de Usuários - obterUsuarios
Este serviço permite consultar os usuários cadastrados na empresa. Os parâmetros de entrada

● Serviço: obterUsuarios

hash string S na tela “Configurações”, aba “Web Service”, botão “Gerar nova
chave SOAP”)
login string Login do usuário na empresa
Usuarios (array de elementos de tipo complexo, contendo os seguintes atributos):
email string S E-mail do usuário a se cadastrado no PontoWEB
nome string N Nome do usuário a ser cadastrado no PontoWEB
perfil string S Perfil de acesso ao sistema a ser atribuído ao usuário.
Lista de strings com as localizações do usuário. Nota: quando enviado

localizacao string[] apenas 1 único elemento, poderão ser enviadas múltiplas localizações
separadas por pipe (|)
Usuarios Usuarios[] Lista de usuários importados
Seguem exemplos para o XML utilizado para exportação de funcionários:
XML de Requisição

<soapenv:Header/>
<soapenv:Body>
<ws:obterUsuarios>
<hash>99999999999999999999999999999999</hash>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
37
Completo Público
Ahgora PontoWEB
<login>pedro.silva@xxxxxx.com.br</login>
</ws:obterUsuarios>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:obterUsuariosResponse>
<usuarios>
<usuario>
<email xsi:type="xsd:string">pedro.silva@xxxxxx.com.br</email>
<nome xsi:type="xsd:string">Pedro da Silva</nome>
<perfil xsi:type="xsd:string">Administrador</perfil>
<localizacao>Loc2</localizacao>
</usuario>
</usuarios>
</ns1:obterUsuariosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
38
Completo Público
Ahgora PontoWEB
1.13. Definição do Serviço de Obtenção de Escalas e Jornadas dos

Funcionários - obterEscalaJornadaFuncionarios
Este serviço permite obter as escalas e jornadas utilizadas pelo colaborador na apuração do
PontoWEB.
● Serviço: obterEscalaJornadaFuncionarios
OBS: Pré-Apuração

matriculas matriculas[] S Lista de matrículas para obtenção dos dados
mes string S Mês desejado
ano string S Ano desejado
matriculas (array de elementos de tipo complexo, contendo os seguintes atributos):
matricula string S Matrícula do funcionário cadastrado no PontoWEB
funcionario funcionario[] Lista de funcionários requisitados
error string Erro encontrados
funcionario (array de elementos de tipo complexo, contendo os seguintes atributos):
matricula string Matrícula do funcionário cadastrado no PontoWEB
data_ultimo_processamento string Última atualização da apuração do funcionário
dados dados[] Lista com os dados de escalas e jornadas

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
39
Completo Público
Ahgora PontoWEB
dados (array de elementos de tipo complexo, contendo os seguintes atributos):
data string Data do dado em questão
Nome da jornada para dado dia para o funcionário em

jornada string
questão
Nome da escala para dado dia para o funcionário em

escala string
questão
Código interno da escala para dado dia para o funcionário

codigo_escala string
em questão
Seguem exemplos para o XML utilizado para a inserção de centros de custo:
XML de Requisição
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.ahgora.com.br/ws">

<soapenv:Header/>
<soapenv:Body>
<obterEscalaJornadaFuncionarios>
<empresa>999999999999999999999999</empresa>
<matriculas>
</matriculas>
<mes>4</mes>
<ano>2019</ano>
</obterEscalaJornadaFuncionarios>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:obterEscalaJornadaFuncionariosResponse>
<EscalaJornada>
<funcionario>
<data_ultimo_processamento>2019-09-03T19:39:37.388Z</data_ultimo_processamento>
<dados>
<data>2019-04-01</data>
<jornada>Semanal</jornada>
<escala>Semanal</escala>
<codigo_escala>023</codigo_escala>
</dados>
…
<dados>
<data>2019-04-30</data>
<jornada>Semanal</jornada>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
40
Completo Público
Ahgora PontoWEB
<escala>Semanal</escala>
<codigo_escala>023</codigo_escala>
</dados>
</funcionario>
</EscalaJornada>
</ns1:obterEscalaJornadaFuncionariosResponse>
</SOAP-ENV:Body>

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
41
Completo Público
Ahgora PontoWEB
1.14. Definição do Serviço para cadastro de CNPJ/CPF da empresa -

sincCadastrosNacionais
Este serviço permite cadastrar os CNPJs ou CPF da empresa do PontoWEB.
● Serviço: sincCadastrosNacionais
OBS: Pré-Apuração

cadastrosNacionais array S
cadastroNacional array S Lista com os cadastros a serem adicionados, ou alterados.
numeroCadastro string S Número do CNPJ ou CPF
razaoSocial string S Razão Social do CNPJ ou CPF
telefoneDDD string DDD da área
telefone string Telefone
cep string CEP
endereco string Endereço
complemento string Complemento
bairro string Bairro
cidade string Cidade
Estado. Deve ser preenchido com uma sigla de dois dígitos

estado string
válida. Ex: “SC”
pais string País - Brasil deve ser “1058”
Indica um CNPJ ou CPF está ativo ou não. Ativo “true”, inativo

ativacao s
“false”.
Seguem exemplos para o XML utilizado para a inserção de CNPJs ou CPFs:
XML de Requisição

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
42
Completo Público
Ahgora PontoWEB
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.ahgora.com.br/ws">

<soapenv:Header/>
<soapenv:Body>
<sincCadastrosNacionais>
<empresa>HASH</empresa>
<cadastrosNacionais>
<cadastroNacional>
<numeroCadastro>99999999999</numeroCadastro>
<razaoSocial>abcabc</razaoSocial>
<telefoneDDD>99</telefoneDDD>
<telefone>999999999</telefone>
<cep>99999999</cep>
<endereco>abcabc</endereco>
<complemento>abcabc</complemento>
<bairro>abcabc</bairro>
<cidade>abcabc</cidade>
<estado>sc</estado>
<pais>1058</pais>
<ativacao>true</ativacao>
</cadastroNacional>
...
<cadastroNacional>
...
</cadastroNacional>
</cadastrosNacionais>
</sincCadastrosNacionais>
</soapenv:Body>
</soapenv:Envelope>
XML de Resposta

<SOAP-ENV:Body>
<ns1:sincCadastrosNacionaisResponse>
<totais>
<adicionados>0</adicionados>
<editados>1</editados>
<removidos>0</removidos>
</totais>
</ns1:sincCadastrosNacionaisResponse>
</SOAP-ENV:Body>
GC - Gestão do Conhecimento

(48) 3084-8500/ 4052-9834 (11) 4063-1050 - Ramal 2301
atribuída.
43

GC T007 - Especificacao Do Web Service Completo - PontoWEB

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

GC T007 - Especificacao Do Web Service Completo - PontoWEB

Enviado por

Direitos autorais:

Formatos disponíveis

Especificação do Web Service

Matriz Florianópolis Filial São Paulo

ahgora.com.br - contato@ahgora.com.br - Rev. 31 -23/04/2021

1. ESPECIFICAÇÃO DO WEB SERVICE

1.1. Sobre o Web Service

O PontoWEB permite a troca de informações com aplicações de terceiros através de um Web

A empresa usuária do PontoWEB é responsável pelo desenvolvimento de um software (ou pela

1.2. Definição do Serviço de Exportação de Batidas - obterBatidas

Seguem os dados para acesso ao serviço de exportação de batidas:

Parâmetro Tipo Obr Conteúdo

Chave de identificação da empresa (obtida a partir do PontoWEB, na tela

Matriz Florianópolis Filial São Paulo

ahgora.com.br - contato@ahgora.com.br - Rev. 31 -23/04/2021

nrep_filtro string Filtro pelo identificador do equipamentoF

Menor nsr da batida a retornar. Caso utilizado em conjunto com o atributo

pis string Filtro opcional pelo PIS do funcionário

Conteúdo de Retorno (array de elementos de tipo complexo, contendo os seguintes atributos):

Parâmetro Tipo Conteúdo

NSR string Número de sequência do registro no relógio ponto

NREP string Número serial do relógio

PIS string PIS do funcionário

data string Data da batida (DDMMYYYY)

hora string Hora da batida (HHMM)

Informação da latitude onde o registro ocorreu. Caso o dispositivo não

Informação da longitude onde o registro ocorreu. Caso o dispositivo não

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.ahgora.com.br/ws">

Matriz Florianópolis Filial São Paulo

ahgora.com.br - contato@ahgora.com.br - Rev. 31 -23/04/2021

Matriz Florianópolis Filial São Paulo

ahgora.com.br - contato@ahgora.com.br - Rev. 31 -23/04/2021

1.3. Definição do Serviço de Sincronização de Funcionários -

Parâmetro Tipo Obr Conteúdo

Chave de identificação da empresa (obtida a partir do PontoWEB, na tela

Lista com os funcionários a serem adicionados, ou alterados. Cada

Funcionários (array de elementos de tipo complexo, contendo os seguintes atributos):

Parâmetro Tipo Obr Conteúdo

matricula string S Matrícula do funcionário

pis string S PIS do funcionário

nome string S Nome do funcionário

codBarras string Código de barras do crachá

biometria string Dados da biometria

Senha para acesso do colaborador.

Senha para ponto REP e Windows. Utilize senha

Lista de strings com as localizações do funcionário.

dataAdmissao string S Data em que o funcionário foi admitido (DDMMAAAA)

Matriz Florianópolis Filial São Paulo

ahgora.com.br - contato@ahgora.com.br - Rev. 31 -23/04/2021

Data em que o funcionário foi demitido (vazio para

ctps string Código CTPS do funcionário

mifare string Cartão mifare associado ao funcionário

cargo string Título do cargo

departamento string Departamento do funcionário

sexo string Gênero do funcionário (M ou F)

email string E-mail do funcionário

cpf string CPF do funcionário

rg string Carteira de Identidade do funcionário (RG)

cnpj string CNPJ da filial que o funcionário está alocado

centroCusto string Código do centro de custo

Regime de trabalho. Uma das opções:

dataNascimento string Data de nascimento do funcionário (DDMMAAAA)

codInterno string Código interno do funcionário

bloqueado boolean Bloquear visualização das batidas pelo funcionário

msgAlertaAcesso string Mensagem de alerta na catraca para o acesso web