> For the complete documentation index, see [llms.txt](https://openapi-docs.exosp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://openapi-docs.exosp.com/start/api-endpoints.md).

# API 요청 및 응답 모델

## 주의 및 제한 사항

* 모든 API 요청에는 유효한 x-exosp-access와 x-exosp-secret 헤더가 포함되어야 합니다.
* Access Key당 하루 최대 1,000번의 API 호출이 허용됩니다.
* 한 번의 호출로 최대 1,000개의 레코드만 요청할 수 있습니다
* 대량의 데이터를 요청할 경우, 페이징 기법을 사용하세요.
* 요청 및 응답에 포함된 모든 시간 데이터는 ISO 8601 형식을 따릅니다.
* 응답 데이터는 JSON 형식으로 제공됩니다.
* 최신 3개월 이내의 데이터만 조회 가능합니다.
* 구독 종료 혹은 OpenAPI 기능 미사용 시 호출이 제한됩니다.

## 요청&#x20;

### Host

* <https://openapi.exosp.com>

### Header

* accept: application/json
* x-exosp-access: 발급 받은 Access Key
* x-exosp-secret: 발급 받은 Secret Key

### Method

* GET

### 공통 요청 데이터

<table><thead><tr><th width="151">항목</th><th width="93">타입</th><th>설명</th></tr></thead><tbody><tr><td>offset</td><td>int</td><td><p><strong>((현재 페이지 번호 -1)*tableSize)</strong><br>페이징 처리를 위한 데이터입니다.</p><p>현재 페이지의 첫 번째 데이터가 위치한 인덱스를 나타냅니다.</p></td></tr><tr><td>tableSize</td><td>int</td><td><p><strong>페이지 사이즈</strong></p><p>페이징 처리를 위한 데이터입니다. (최대값 : 1000) </p></td></tr><tr><td>timezone</td><td>string</td><td><strong>응답 데이터의 타임존</strong><br>응답 데이터의 시각을 해당 타임존으로 변환하여 전달합니다. <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a> 에서 TZ identifier 참고 하세요. (기본값 : UTC)</td></tr></tbody></table>

{% code title="Request 예제" fullWidth="false" %}

```sh
curl -X 'GET' \
  'https://openapi.exosp.com/status/v1/ip?offset=0&tableSize=1&timezone=Asia%2FSeoul' \
  -H 'accept: application/json' \
  -H 'x-exosp-access: YOUR_ACCESS_KEY' \
  -H 'x-exosp-secret: YOUR_ACCESS_SECRET' 
```

{% endcode %}

## 응답

### 공통 응답 데이터

<table><thead><tr><th width="147">항목</th><th width="104">타입</th><th>설명</th></tr></thead><tbody><tr><td>code</td><td>int</td><td><p><strong>응답 처리 결과 코드</strong> </p><p>0 : 성공, 1 : 실패</p></td></tr><tr><td>message</td><td>string</td><td><p><strong>응답 처리 결과 메세지</strong></p><p>success : 성공, 그 외 : 실패</p></td></tr><tr><td>body</td><td>object</td><td><p><strong>응답 데이터</strong></p><p>각 기능에 따라 세부 내용이 다릅니다.</p></td></tr></tbody></table>

{% code title="(성공) Response 예제" %}

```json
{
  "code": 0,
  "message": "success",
  "body": {
    "total": 24,
    "data": [
      {
        "name": "신은진",
        "departmentName": "디자인",
        "departmentFull": "어벤져스 > 비즈니스 > 디자인",
        "computerName": "어변져스의 iMac",
        "osType": "macos",
        "osDescription": "Sonoma",
        "osUserName": "어변져스(designer)",
        "publicIP": "211.171.171.190",
        "privateIP": "10.100.73.10",
        "dateOfEntryUTC": "2024-07-15T23:27:08+00:00",
        "dateOfEntry": "2024-07-16T08:27:08+09:00"
      }
    ]
  }
}
```

{% endcode %}

{% code title="(실패) Response 예제" %}

```json
{
  "code": 1,
  "message": "tableSize cannot be greater than 1000"
}
```

{% endcode %}
