# XEngine_APIService

**Repository Path**: xengine/XEngine_APIService

## Basic Information

- **Project Name**: XEngine_APIService
- **Description**: c c++ 信息查询服务 c c++ information query service
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: develop
- **Homepage**: https://github.com/libxengine/XEngine_APIService
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2022-03-01
- **Last Updated**: 2026-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[中文](README.md) ||  [English](README.en.md)  
# XEngine_APIService
This repository has a development and master branch. If you want to use it, please use the master branch  
As long as the repository is not in suspended state, we will maintain and develop it all the time, please use it with confidence  

## Introduction
c c++ 接口服务器  
c c++ interface api service  
This is an api interface for information query service,At present, the information search service on the market need to charge, and our information search service is free and open source.  
Not only is it a query service, but it can also provide functions such as machine management and process deamon.  
This service mainly uses HTTP/V1.1 to implement various interface services  
This is a general information query service that does not contain any language attributes
You can use this code to implement your own information query service, which supports querying any information  
The purpose of development and implementation based on libXEngine is a cross-platform network storage service  
and support plugin system,dll(so,dylib)module or lua script  

#### Why choose us
Support privatization deployment, free, safe, open source, controllable  
Dozens of information queries are completely free and open source, while similar products are all charged for API counting.  
Supports third-party interface data caching. It can save you the cost of other query information.  
It allows you to save 90% of information service costs in a year.  

## Software feature
1. permission verication
2. support ip address location information query
3. support ID verification and information query
4. support phone number information query
5. Weather forecast
6. Lunar calendar conversion (planning)
7. News headlines (planned)
8. Standard height and weight
9. Zodiac Constellation
10. Password generator
11. World Time Zones
12. Oil price inquiry
13. Administrative zip code
14. Bank card verification
15. Exchange rate calculation (planned)
16. QR code generation and parse
17. Twenty-four solar terms (planned)
18. Translation
19. Metering Conversion
20. network test
21. Distributed lock
22. short url creator and forward
23. local system time
24. math Calculation
25. log service
26. Plugin hot reload
27. Sensitive word detection
28. remote control(back management)
29. Image Process
30. process deamon
31. Region ID Convert
32. Machine Information Collect
33. heartbeat 
34. STUN NAT Protocol 
35. NTP Time Sync Protocol
36. mac address vendor query
37. ORC Get TEXT With image
38. P2P
39. DNS protocol support

## install

#### XEngine Evn
you must install XEngine,need V9.x or above,install XEngine can be refer to xengine Readme docment  
GITEE:https://gitee.com/libxengine/libxengine  
GITHUB:https://github.com/libxengine/libxengine

##### fast to deployment 
git clone https://gitee.com/libxengine/libxengine.git or git clone https://github.com/libxengine/libxengine.git  
window Exection XEngine_WINEnv.bat   
Linux Exection:sudo ./XEngine_LINEnv.sh -i 3  
Macos Exection:./XEngine_LINEnv.sh -i 3

####### Development environment
It is recommended to use github to pull the code, and use the VS2022+COPILOG combination. Copilot will automatically help you analyze and modify the code  
In order to save resources, now the IP and phone and mac databases need to be copied by themselves. Execute the XEngine_Release/copydb.bat(copydb.sh) script. Otherwise, an error will be reported

#### Database Env
MYSQL database version 8.0 or above is required. Create a table through CreateDatabase.sql, and then import other sql table
Modify the database configuration in XSQL in the configuration file to your  
The default configuration does not enable database support. If the database interface is required, you need to enable the database yourself

#### Windows
need to vcpkg configure third-part env.refer vcpkg install guide.after installed and execution:vcpkg.exe install lua:x86-windows opencv[contrib,freetype]:x86-windows libqrencode:x86-windows leptonica:x86-windows tesseract:x86-windows lua:x64-windows opencv[contrib,freetype]:x64-windows libqrencode:x64-windows leptonica:x64-windows tesseract:x64-windows  
use vs open and compile,suport windows 7sp1 and above  
Just Run it

#### sub module
Due to the dependent sub-modules, after you checkout the resprepository, execute the following command in the resprepository directory to pull the sub-modules  
git submodule init  
git submodule update  

#### Linux
ubuntu:sudo apt install sudo apt install liblua5.4-dev libopencv-dev libopencv-contrib-dev libqrencode-dev libleptonica-dev libtesseract-dev -y  
centos:sudo dnf install lua-devel opencv-devel qrencode-devel leptonica-devel tesseract-devel -y  
use makefile compile,UBUNTU24.04 x64 or RockyLinux 9 x64  
Run it on the terminal

#### Macos
install environment:brew install lua opencv qrencode leptonica tesseract  
use makefile compile,mac 13 and above  
Run it on the terminal

##### complie
execute command in XEngine_Source path  
make complie  
make FLAGS=InstallAll install  
make FLAGS=CleanAll clear 

## system task list
delete file  
delete dir  
upload a file to ftp  
Request a list of files in the folder  
execute program  
terminal process  
remote shutdown computre  
execute command  
information report  

#### use

1.  Switch to the MASTER branch
2.  download code
3.  complie
4.  install
5.  run

## directory struct
- XEngine_Docment   docment directory
- XEngine_Release   install directory
- XEngine_Source    code    directory  
- XEngine_APPClient client  code dir  

## Plugin description
You can refer to the project under XEngine_PluginModule to write the plugin  
The written plugin needs to be configured via JSON to be enabled  

## now task

## other problems   
You can refer to the document under the docment directory. It contains API protocol and service description.  

## Test Service
Address:app.libxengine.com,Port:5501  
#### example
For more information please refer to the documentation  
id information query  
api:http://app.libxengine.com:5501/api?function=id&params1=511025198800000000
```json
{
    "code":0,
    "data":{
        "nBirthDay":00,
        "nBirthMonth":00,
        "nBirthYear":1988,
        "nCheck":2,
        "nPoliceID":87,
        "nSex":1,
        "tszCity":"内江市",
        "tszCounty":"资中县",
        "tszIDNumber":"511025198800000000",
        "tszProvincer":"四川省"
    },
    "msg":"success"
}
```
bank card ver  
api:http://app.libxengine.com:5501/api?function=bank&params1=6214832830000000
```json
{
    "code":0,
    "data":{
        "enBankType":2,
        "tszBankAbridge":"CMB",
        "tszBankName":"招商银行",
        "tszBankNumber":"6214832830000000"
    },
    "msg":"success"
}
```
translation  
api:http://127.0.0.1:5501/api?function=translation&msg=中文翻译成英文&src=1&dst=2
```json
{
    "code":0,
    "data":{
        "tszDestStr":"Translate from Chinese to English",
        "tszFromStr":"zh",
        "tszSourceStr":"中文翻译成英文",
        "tszToStr":"en"
    },
    "msg":"success"
}
```
Distributed Lock  
Api:http://app.libxengine.com:5501/api?function=lock&params1=1000154321&params2=1
```json
{
    "code":0,
    "data":{
        "xhToken":1000154321
    },
    "msg":"success"
}
```
ZIPCode  
Api:http://app.libxengine.com:5501/api?function=zipcode&params1=0  
```json
{
    "nZipCode":100010
}
```
Log  
Api:http://app.libxengine.com:5501/api?function=log&params1=1  
```json
{
    "tszTableName":"xengine",
    "tszLogBuffer":"d12d",
    "nLogSize":4,
    "tszFileName":"file.cpp",
    "tszFuncName":"xengine_file_insert",
    "tszLogTimer":"2023-01-13 22:10:01",
    "nLogLine":102,
    "nLogLevel":4
}
```
Oil Query  
API:http://app.libxengine.com:5501/api?function=oil&addr=四川  
```json
{
    "code": 0,
    "data": {
        "dlValue0": 7.9100000000000001,
        "dlValue10": 8.3800000000000008,
        "dlValue20": 8.6899999999999995,
        "dlValue35": 0,
        "dlValue92": 8.2799999999999994,
        "dlValue95": 8.8499999999999996,
        "dlValue98": 9.6199999999999992,
        "tszCityStr": "四川",
        "tszUPTime": "2024-05-08 14:39:53"
    },
    "msg": "success"
}
```
## Participate in contribution
I hope you will submit more code to participate in the contribution  

1. Fork this code
2. Create new Feat_xxx branch
3. Submit the code
4. New Pull Request  

## Follow us
If you think this software is helpful to you, please give us a START

## post issues

if you have eny quest.post issues...