Notification

알림 관련 API

알림 목록 조회

post

https://api-b2c.tikkly.iohttps://api.tikkly.comhttp://localhost:8081

/tikkly-b2c/notifications

UUID로 사용자의 알림 목록을 조회합니다

Header parameters

x-api-keystringRequired

API Key

Default: TEST_API_KEYExample: TEST_API_KEY

Body

application/json

uuidstringRequired

사용자 UUID

Example: 40115395-195e-4c14-b5f4-261f13da353e

onlyUnreadbooleanOptional

읽지 않은 알림만 조회

Default: false

pageinteger · min: 1Optional

페이지 번호

Default: 1

pageSizeinteger · min: 1 · max: 100Optional

페이지당 항목 수

Default: 20

Responses

200

알림 목록 조회 성공

application/json

401

인증 실패

404

사용자를 찾을 수 없음

post

/tikkly-b2c/notifications

HTTPcURLJavaScriptPython

POST /tikkly-b2c/notifications HTTP/1.1
Host: api-b2c.tikkly.io
x-api-key: TEST_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "uuid": "40115395-195e-4c14-b5f4-261f13da353e",
  "onlyUnread": false,
  "page": 1,
  "pageSize": 20
}

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "notifications": [
      {
        "id": 1,
        "kind": "TRADE_COMPLETED",
        "refType": "trade",
        "refId": 123,
        "createdAt": "2024-01-15T10:30:00Z",
        "readAt": null
      }
    ],
    "totalCount": 50,
    "page": 1,
    "pageSize": 20
  }
}

읽지 않은 알림 개수

post

https://api-b2c.tikkly.iohttps://api.tikkly.comhttp://localhost:8081

/tikkly-b2c/notifications/unread-count

UUID로 읽지 않은 알림의 개수를 조회합니다

Header parameters

x-api-keystringRequired

API Key

Default: TEST_API_KEYExample: TEST_API_KEY

Body

application/json

uuidstringRequired

사용자 UUID

Default: 40115395-195e-4c14-b5f4-261f13da353eExample: 40115395-195e-4c14-b5f4-261f13da353e

Responses

200

조회 성공

application/json

401

인증 실패

404

사용자를 찾을 수 없음

post

/tikkly-b2c/notifications/unread-count

HTTPcURLJavaScriptPython

POST /tikkly-b2c/notifications/unread-count HTTP/1.1
Host: api-b2c.tikkly.io
x-api-key: TEST_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "uuid": "40115395-195e-4c14-b5f4-261f13da353e"
}

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "unreadCount": 5
  }
}

알림 읽음 처리

post

https://api-b2c.tikkly.iohttps://api.tikkly.comhttp://localhost:8081

/tikkly-b2c/notifications/{id}/read

UUID로 특정 알림을 읽음으로 표시합니다

Path parameters

idintegerRequired

알림 ID

Example: 1

Header parameters

x-api-keystringRequired

API Key

Default: TEST_API_KEYExample: TEST_API_KEY

Body

application/json

uuidstringRequired

사용자 UUID

Default: 40115395-195e-4c14-b5f4-261f13da353eExample: 40115395-195e-4c14-b5f4-261f13da353e

Responses

200

읽음 처리 성공

application/json

401

인증 실패

404

알림을 찾을 수 없음

post

/tikkly-b2c/notifications/{id}/read

HTTPcURLJavaScriptPython

POST /tikkly-b2c/notifications/{id}/read HTTP/1.1
Host: api-b2c.tikkly.io
x-api-key: TEST_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "uuid": "40115395-195e-4c14-b5f4-261f13da353e"
}

{
  "statusCode": 200,
  "message": "Success"
}

모든 알림 읽음 처리

post

https://api-b2c.tikkly.iohttps://api.tikkly.comhttp://localhost:8081

/tikkly-b2c/notifications/read-all

UUID로 사용자의 모든 알림을 읽음으로 표시합니다

Header parameters

x-api-keystringRequired

API Key

Default: TEST_API_KEYExample: TEST_API_KEY

Body

application/json

uuidstringRequired

사용자 UUID

Default: 40115395-195e-4c14-b5f4-261f13da353eExample: 40115395-195e-4c14-b5f4-261f13da353e

Responses

200

모두 읽음 처리 성공

application/json

401

인증 실패

404

사용자를 찾을 수 없음

post

/tikkly-b2c/notifications/read-all

HTTPcURLJavaScriptPython

POST /tikkly-b2c/notifications/read-all HTTP/1.1
Host: api-b2c.tikkly.io
x-api-key: TEST_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "uuid": "40115395-195e-4c14-b5f4-261f13da353e"
}

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "updatedCount": 5
  }
}