API: O que é e Como Funciona
Uma API, ou Interface de Programação de Aplicações, é um conjunto de regras e protocolos que permitem que diferentes softwares se comuniquem entre si. Ela define os métodos de como os componentes de software devem interagir, facilitando a integração de sistemas e serviços.
Exemplo:
Uma API pode ser comparada a um garçom em um restaurante. Ele faz a ponte entre você (o cliente) e a cozinha (o sistema que prepara a comida).
Para maiores informações sobre a API da QRPoint, acesse: https://api.qrpoint.com.br/v1/docs
Principais funções que uma API pode realizar:
Integração de sistemas: APIs permitem que diferentes sistemas se comuniquem entre si de maneira padronizada. Por exemplo, uma API pode permitir que um aplicativo web se comunique com um banco de dados, um serviço de pagamento online, ou uma rede social.
Abstração de complexidade: Uma API pode ocultar detalhes complexos e fornecer uma interface simplificada para desenvolvedores que desejam utilizar determinada funcionalidade. Isso permite que desenvolvedores utilizem recursos sem precisar entender todos os detalhes de implementação subjacentes.
Reutilização de código: Ao fornecer funcionalidades através de uma API, desenvolvedores podem reutilizar o código sem precisar reimplementar tudo do zero. Por exemplo, uma API de mapa pode ser usada por vários aplicativos sem que cada um tenha que desenvolver sua própria funcionalidade de mapas.
Segurança: APIs podem implementar medidas de segurança para proteger os dados e os recursos que estão sendo acessados. Isso inclui autenticação, autorização e criptografia de dados transmitidos.
Facilitação da inovação: Ao fornecer acesso a funcionalidades específicas, APIs podem incentivar a inovação ao permitir que desenvolvedores criem novos aplicativos ou serviços que utilizem essas funcionalidades de maneiras criativas e inovadoras.
Escalabilidade: APIs bem projetadas facilitam a escalabilidade de sistemas, permitindo que serviços sejam expandidos conforme a demanda, sem a necessidade de grandes mudanças na infraestrutura subjacente.
Padronização: APIs definem um padrão de comunicação entre sistemas, o que ajuda na interoperabilidade entre diferentes plataformas e tecnologias.
PARÂMETROS GLOBAIS ¶
O parâmetro “returnType” via querystring define o tipo de retorno:
xml: retorna um xml
json(padrão): retorna json
XML ¶
Como exemplo de conversão do JSON para o XML temos:
JSON:
[{ "chave": "valor" }]Que, ao utilizar o parâmetro returnType=xml, torna-se XML:
<root> <element> <chave>valor</chave> </element> </root>
No caso de mensagens de erro, temos:
JSON:
{ "message": "erro" }XML:
<root> <message>erro</message> </root>
Agora veremos umas das formas de integrações que a API do sistema da QRPoint nos permite fazer:
TOKEN
A obtenção do token da API do QRPoint é realizada via tela de configurações do sistema. O token é responsável pela sua autenticação em nossa API, a utilização dele implica diretamente nos dados retornados.
Dados gerais
EMPREGADOR
GET/employer{?id}
URI Parameters Hide
id string (optional) Example: abcd123
Identificador único do empregador. Você pode omitir este parâmetro para retornar todos os empregadores.
COLABORADOR
GET/employee{?pin,cpf,codempresa}
URI Parameters Hide
pinstring (optional) Example: 1234
Identificador único do colaborador na empresa. Você pode passar quantos PINs desejar via query string. Caso não passe o PIN, deverá passar o CPF.
cpfstring (optional) Example: 12345678910
CPF do colaborador. Você só deve passar um CPF por vez via query string. Caso não passe o CPF, deverá passar o PIN.
codempresastring (optional) Example: asdf1234
Código único da empresa. Você só deve passar um codempresa por vez via query string. Caso não passe o codempresa, deverá passar o PIN ou CPF.
Registros de ponto
REGISTROS
GET/attendance-records{?employerId,startDate,endDate}
URI Parameters Hide
employerIdstring (required) Example: abc123
Identificador único do empregador na empresa. Você pode passar quantos IDs desejar via query string.
startDatestring (required) Example: 20240101
Data inicial dos registros de ponto no formato YYYYMMDD. Você só deve passar um startDate por vez via query string.
endDatestring (required) Example: 20240131
Data final dos registros de ponto no formato YYYYMMDD. Você só deve passar um endDate por vez via query string.
CÁLULOS
FOLHA
GET/timesheet{?employeesId,employeesCpf,employerId,startDate,endDate}
URI Parameters Hide
employeesIdnumber (optional) Example: 1
Id do colaborador, obtido na requisição de dados do colaborador. Você pode passar quantos employeesId desejar via query string. Caso não passe o ID, o CPF deve ser passado.
employeesCpfstring (optional) Example: 12345678910
CPF do colaborador. Você pode passar quantos employeesCpf desejar via query string. Caso não passe o CPF, o ID deve ser passado.
employerIdstring (optional) Example: 123456
Id do empregador, obtido na requisição de dados do colaborador. Você deve passar apenas um employerId por vez via query string. Caso não passe o employerId, o ID ou CPF devem ser passados.
startDatestring (required) Example: 20200101
Data de início do período desejado para cálculo.
endDatestring (required) Example: 20200131
Data de término do período desejado para cálculo.
Em resumo, as APIs são essenciais para a criação de aplicações modernas e para a integração de sistemas, proporcionando uma maneira flexível e eficiente de interagir com funcionalidades e dados de outras aplicações e serviços.
Atenciosamente,
QRPoint
Maria Victoria.