# boku_sip2_api

**Repository Path**: kzeng/boku_sip2_api

## Basic Information

- **Project Name**: boku_sip2_api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-14
- **Last Updated**: 2025-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SIP2 HTTP API SERVICE

## Docs

- [Developer's Guide](docs/SIP2+Developers+Guide.docx)
- [Protocol Definition](docs/SIP2+Protocol+Definition.docx)

- **[SIP2 HTTP API Documentation](docs/sip2_http_api.md)**

---

## Add Config File 

`webapp\Sip2\.boku_config.json`  

```json
{
    "hostName"  : ACS_IP_ADDRESS,
    "hostPort"  : ACS_PORT,
    "User"      : SC_NAME,
    "Pwd"       : SC_PASSWORD,
    "Patron"    : PATRON,
    "PatronPwd" : PATRON_PASSWORD
}
```

## Run Test Script `test.py`

The following is the resoponse message of `/login`

Login Response: 
```json
{
  "fixed": {
    "Ok": "1"
  },
  "variable": {
    "Raw": [
      "AY3"
    ],
    "AY": [
      "3"
    ],
    "AZ": [
      "FDFA"
    ]
  }
}
```
---------------------------------------------------------------------------

## Start SIP2 HTTP API Server
```bash
cd webapp
python app.py
```


### Test HTTP API `/login`
```bash
curl -X POST http://localhost:5588/login -H "Content-Type: application/json" -d '{"user_id": "your_user_id", "password": "your_password"}'
```
------
Response:    

```json
{
  "response": {
    "fixed": {
      "Ok": "1"
    },
    "variable": {
      "AY": [
        "3"
      ],
      "AZ": [
        "FDFA"
      ],
      "Raw": [
        "AY3"
      ]
    }
  }
}
```

### SIP2 HTTP API TEST PAGE

`http://localhost:5588`

![SIP2_HTTP_API_Test_Page](docs/SIP2_HTTP_API_Test_Page.png)