토큰 관리
1. 토큰을 생성
토큰의 생성은 토큰 발행 절차를 따릅니다.
2. 토큰 목록을 조회
토큰 목록을 조회합니다.
기본 정보
URI | /token/admin |
---|---|
METHOD | GET |
Content-Type | |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
query | string | tokenName | O | 테스트토큰 | - | 토큰 이름, 부분 조회 허용 | |
string | tokenSymbol | O | TT | - | 토큰 심볼 | ||
string | startDate | O | 2021-09-01 | - | 생성일 기준 조회 시작일 | ||
enum | endDate | O | 2021-09-02 | - | 생성일 기준 조회 종료일 | ||
number | skip | O | 0 | 0 | skip row count | ||
number | take | O | 10 | 10 | take row count | ||
string | sort | O | tokenSymbol | - | 정렬 대상 컬럼명 | ||
string | order | O | DESC | - | 정렬 순서 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
Pagenate<Token> | number | total | M | 18 | 대상 전체 수 |
number | skip | M | 0 | skip row count | |
number | take | M | 10 | take row count | |
number | count | M | 5 | current row count | |
Token[] | contents | O | [ ] | 토큰 정보 목록 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' }' |
Response Sample Code
{ "total": 1, "skip": 0, "take": 10, "contents": [ { "tokenSeq": 1, "tokenName": "테스트토큰1", "tokenSymbol": "TEST1", "tokenInitialSupply": 0, "tokenInitialHolderId": "", "tokenTotalSupply": 0, "tokenDescription": "테스트토큰1 설명", "tokenStatus": "ACTIVATED", "tokenContractSeq": 1, "tokenContractAddress": "test-addresss", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": null, "updatedAt": "2021-09-04T11:17:24.000Z", "updatedBy": null } ] } |
3. 토큰의 상세 정보를 조회
토큰의 상세 정보(토큰 기본 정보, 토큰에 가입된 토큰 사용자 목록)를 조회합니다.
기본 정보
URI | /token/admin/{tokenSeq} |
---|---|
METHOD | GET |
Content-Type | - |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
query | number | tokenSeq | M | 1 | - | 토큰 일련번호 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenDto | number | tokenSeq | M | 1 | 토큰 일련번호 |
string | tokenName | M | 테스트토큰 | 토큰 이름 | |
string | tokenSymbol | O | TT | 토큰 심볼 | |
number | tokenTotalSupply | O | 0 | 토큰 발행 총량 | |
string | tokenDescription | O | 테스트용 발행 토큰 | 토큰 설명 | |
string | tokenStatus | ACTIVATED | 토큰 상태 | ||
number | tokenContractSeq | 1 | 토큰 발행 컨트랙트 일련번호 | ||
string | tokenContractAddress | 0x3F8F7B49EaD5f70820268a3C222B11FbC5b739EE | 발행된 CA(contract address) | ||
string | createdAt | 2021-09-04T11:17:24.000Z | 생성 일시 | ||
string | createdBy | gildong.hong | 생성자 ID | ||
string | updatedAt | 2021-09-04T11:17:24.000Z | 수정 일시 | ||
string | updatedBy | gildong.hong | 수정자 ID | ||
TokenUserDto[] | admins | [ ] | 토큰 관리자 목록 | ||
TokenUserDto[] | members | [ ] | 토큰 사용자 목록 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin/1' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' }' |
Response Sample Code
{ "tokenSeq": 1, "tokenName": "테스트토큰1", "tokenSymbol": "TEST1", "tokenInitialSupply": 0, "tokenInitialHolderId": "", "tokenTotalSupply": 0, "tokenDescription": "테스트토큰1 설명", "tokenStatus": "ACTIVATED", "tokenContractSeq": 1, "tokenContractAddress": "test-addresss", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": null, "updatedAt": "2021-09-04T11:17:24.000Z", "updatedBy": null, "admins": [ { "tokenUserId": "gildong.hong", "tokenUserName": "홍길동", "tokenUserOrganization": "인력팀", "tokenUserOwnedAddress": "0x3F8F7B49EaD5f70820268a3C222B11FbC5b739EE", "isAdmin": true, "joinedAt": "2021-09-04T11:17:24.000Z", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": "gildong.hong", "updatedAt": null, "updatedBy": null } ], "members": [] } |
4. 토큰의 정보 변경
토큰의 정보를 변경합니다.
기본 정보
URI | /token/admin/{tokenSeq} |
---|---|
METHOD | PATCH |
Content-Type | application/json |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | string | tokenSeq | M | 1 | - | 변경할 대상 토큰의 일련번호 | |
Body | string | tokenName | O | 변경된토큰명 | - | 변경할 토큰 이름 | |
string | tokenSymbol | O | TTT | - | 변경할 토큰 심볼 | ||
string | tokenDescription | O | 변경된설명 | - | 변경할 토큰 설명 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
Token | number | tokenSeq | M | 1 | 토큰 일련번호 |
string | tokenName | M | 테스트토큰 | 토큰 이름 | |
string | tokenSymbol | O | TT | 토큰 심볼 | |
number | tokenInitialSupply | M | 10000 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | O | 2021-09-01T00:01:02Z | 토큰 초기 발행자 | |
number | tokenTotalSupply | O | 0 | 토큰 발행 총량 | |
string | tokenDescription | O | 테스트용 발행 토큰 | 토큰 설명 | |
string | tokenStatus | ACTIVATED | 토큰 상태 | ||
number | tokenContractSeq | 1 | 토큰 발행 컨트랙트 일련번호 | ||
string | tokenContractAddress | 0x3F8F7B49EaD5f70820268a3C222B11FbC5b739EE | 발행된 CA(contract address) | ||
string | createdAt | 2021-09-04T11:17:24.000Z | 생성 일시 | ||
string | createdBy | gildong.hong | 생성자 ID | ||
string | updatedAt | 2021-09-04T11:17:24.000Z | 수정 일시 | ||
string | updatedBy | gildong.hong | 수정자 ID |
Request Sample Code
curl -X 'PATCH' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin/1' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \ -d '{ "tokenName": "변경된토큰명", "tokenSymbol": "TTT", "tokenDescription": "변경된토큰설명" }' |
Response Sample Code
{ "tokenSeq": 1, "tokenName": "변경된토큰명", "tokenSymbol": "TTT", "tokenInitialSupply": 0, "tokenInitialHolderId": "", "tokenTotalSupply": 0, "tokenDescription": "변경된토큰설명", "tokenStatus": "ACTIVATED", "tokenContractSeq": 1, "tokenContractAddress": "test-addresss", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": null, "updatedAt": "2021-09-06T21:40:45.000Z", "updatedBy": null } |
5. 토큰을 삭제
토큰을 삭제한다. 토큰의 상태를 CLOSED로 변경한 뒤 일정시간 경괴 후 삭제 절차를 수행합니다.
기본 정보
URI | /token/admin/{tokenSeq} |
---|---|
METHOD | DELETE |
Content-Type | - |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | number | tokenSeq | M | 1 | - | 삭제할 토큰 일련번호 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
Token | number | tokenSeq | M | 1 | 토큰 일련번호 |
string | tokenName | M | 테스트토큰 | 토큰 이름 | |
string | tokenSymbol | O | TT | 토큰 심볼 | |
number | tokenInitialSupply | M | 10000 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | O | 2021-09-01T00:01:02Z | 토큰 초기 발행자 | |
number | tokenTotalSupply | O | 0 | 토큰 발행 총량 | |
string | tokenDescription | O | 테스트용 발행 토큰 | 토큰 설명 | |
string | tokenStatus | ACTIVATED | 토큰 상태 | ||
number | tokenContractSeq | 1 | 토큰 발행 컨트랙트 일련번호 | ||
string | tokenContractAddress | 0x3F8F7B49EaD5f70820268a3C222B11FbC5b739EE | 발행된 CA(contract address) | ||
string | createdAt | 2021-09-04T11:17:24.000Z | 생성 일시 | ||
string | createdBy | gildong.hong | 생성자 ID | ||
string | updatedAt | 2021-09-04T11:17:24.000Z | 수정 일시 | ||
string | updatedBy | gildong.hong | 수정자 ID |
Request Sample Code
curl -X 'DELETE' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin/1' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
{ "tokenSeq": 1, "tokenName": "변경된토큰명", "tokenSymbol": "TTT", "tokenInitialSupply": 0, "tokenInitialHolderId": "", "tokenTotalSupply": 0, "tokenDescription": "변경된토큰설명", "tokenStatus": "ACTIVATED", "tokenContractSeq": 1, "tokenContractAddress": "test-addresss", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": null, "updatedAt": "2021-09-06T21:40:45.000Z", "updatedBy": null } |
6. 토큰의 관리자 변경
토큰의 관리자를 다른 사용자(관리자)로 변경합니다.
기본 정보
URI | /token/admin/{tokenSeq}/admin |
---|---|
METHOD | PUT |
Content-Type | application/json |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | ChangeTokenAdminInput | string | newTokenAdminUserId | M | gildong.hong | - | 변경할 토큰 관리자 Id |
string | oldTokenAdminUserId | M | muge.ah | - | 기존 토큰 관리자 Id |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenMemberHistory | number | historySeq | M | 1 | 이력 일련번호 |
number | tokenSeq | M | 1 | 토큰 일련번호 | |
number | tokenName | M | 테스트토큰 | 토큰 이름 | |
number | tokenSymbol | M | TTT | 토큰 심볼 | |
string | tokenUserId | M | muge.ah | 토큰 사용자 ID | |
string | tokenUserName | M | 아무개 | 토큰 사용자 이름 | |
enum | opCode | M | GIVE_ADMIN | 작업 코드 | |
enum | opState | M | PENDING | 작업 상태 | |
string | opResult | O | 0 | 결과 코드 | |
string | opDetail | O | 작업 상세 | ||
string | opAt | M | 2021-09-01T00:01:02.000Z | 요청 일시 | |
string | updatedAt | O | 2021-09-01T00:01:02.000Z | 처리 일시 |
Request Sample Code
curl -X 'POST' \ 'https://{{TOKEN-SERVICE-URL}}/user/info' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \ -d '{ "userId": 24, "userName": 1, "organization": "test-admin1", "userRoles": [ "TOKEN_ADMIN" ] }' |
Response Sample Code
{ } |
7. 토큰에 새로운 토큰 사용자 추가
토큰에 새로운 토큰 사용자를 추가(가입)합니다.
기본 정보
URI | /token/admin/{tokenSeq}/member/{tokenUserId} |
---|---|
METHOD | PUT |
Content-Type | application/json |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | number | tokenSeq | M | 1 | - | 토큰 일련번호 | |
string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID | ||
query | boolean | isAdmin | O | true | - | 관리자 여부 | |
CreateTokenUserDto | string | tokenUserId | O | muge.ah | - | 토큰 사용자 ID | |
string | tokenUserName | O | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | O | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenMember | number | total | M | 18 | 대상 전체 수 |
number | skip | M | 0 | skip row count | |
number | take | M | 10 | take row count | |
number | count | M | 5 | current row count | |
User[] | contents | O | [ ] | 사용자 정보 |
Request Sample Code
curl -X 'PUT' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin/1/member/muge.ah?isAdmin=false' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \ -d '{ "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e" }' |
Response Sample Code
{ "tokenSeq": 1, "tokenUserId": "muge.ah", "isAdmin": false, "status": "ACTIVATED", "createdAt": "2021-09-07T02:32:52.000Z", "createdBy": "muge.ah", "updatedAt": null, "updatedBy": null, "token": { "tokenSeq": 1, "tokenName": "변경된토큰명", "tokenSymbol": "TTT", "tokenInitialSupply": 0, "tokenInitialHolderId": "", "tokenTotalSupply": 0, "tokenDescription": "변경된토큰설명", "tokenStatus": "CLOSED", "tokenContractSeq": 1, "tokenContractAddress": "test-addresss", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": null, "updatedAt": "2021-09-07T06:42:45.648Z", "updatedBy": "" }, "tokenUser": { "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": "2021-09-07T11:32:52.000Z", "updatedBy": null } } |
8. 토큰의 토큰 사용자 목록 조회
토큰에 가입되어 있는 토큰 사용자 목록을 조회합니다.
기본 정보
URI | /token/{tokenSeq}/member |
---|---|
METHOD | GET |
Content-Type | - |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | number | tokenSeq | M | 1 | - | 토큰 일련번호 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenMember[] | string | tokenSeq | M | gildong.hong | 토큰 사용자 ID |
string | tokenUserId | M | 홍길동 | 토큰 사용자 이름 | |
string | isAdmin | O | 인력팀 | 토큰 사용자 조직 | |
enum | status | M | ACTIVATED | 토큰 가입 상태 | |
string | createdAt | M | 2021-09-01T00:01:02Z | 생성 일시 | |
string | createdBy | O | muge.ah | 생성자 ID | |
string | updatedAt | O | 2021-09-01T00:01:02Z | 수정 일시 | |
string | updatedBy | 수정자 ID | |||
TokenUser | tokenUser | 토큰 사용자 상세 정보 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin/1/member' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
[ { "tokenSeq": 1, "tokenUserId": "hobros", "isAdmin": true, "status": "ACTIVATED", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": "hobros", "updatedAt": null, "updatedBy": null, "tokenUser": { "tokenUserId": "hobros", "tokenUserName": "김기덕", "tokenUserOrganization": "블록체인플랫폼", "tokenUserOwnedAddress": "0x3F8F7B49EaD5f70820268a3C222B11FbC5b739EE", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": "hobros", "updatedAt": null, "updatedBy": null } }, { "tokenSeq": 1, "tokenUserId": "muge.ah", "isAdmin": false, "status": "ACTIVATED", "createdAt": "2021-09-06T23:06:15.000Z", "createdBy": "muge.ah", "updatedAt": null, "updatedBy": null, "tokenUser": { "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": "2021-09-07T08:06:12.000Z", "updatedBy": null } } ] |
8. 토큰에 가입되어 있는 토큰 사용자의 상세 정보 조회
토큰에 가입되어 있는 토큰 사용자의 상제 정보를 조회합니다.
기본 정보
URI | /token/{tokenSeq}/member/{tokenUserId} |
---|---|
METHOD | GET |
Content-Type | - |
Role | All |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | number | tokenSeq | M | 1 | - | 토큰 일련번호 | |
string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenMember[] | string | tokenSeq | M | gildong.hong | 토큰 사용자 ID |
string | tokenUserId | M | 홍길동 | 토큰 사용자 이름 | |
string | isAdmin | O | 인력팀 | 토큰 사용자 조직 | |
enum | status | M | ACTIVATED | 토큰 가입 상태 | |
string | createdAt | M | 2021-09-01T00:01:02Z | 생성 일시 | |
string | createdBy | O | muge.ah | 생성자 ID | |
string | updatedAt | O | 2021-09-01T00:01:02Z | 수정 일시 | |
string | updatedBy | O | gildong.hong | 수정자 ID | |
Token | token | M | { } | 토큰 정보 | |
TokenUser | tokenUser | M | { } | 토큰 사용자 정보 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/admin/1/member/muge.ah' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
{ "tokenSeq": 1, "tokenUserId": "muge.ah", "isAdmin": false, "status": "ACTIVATED", "createdAt": "2021-09-07T02:32:52.000Z", "createdBy": "muge.ah", "updatedAt": "2021-09-07T11:44:48.000Z", "updatedBy": "muge.ah", "token": { "tokenSeq": 1, "tokenName": "변경된토큰명", "tokenSymbol": "TTT", "tokenInitialSupply": 0, "tokenInitialHolderId": "", "tokenTotalSupply": 0, "tokenDescription": "변경된토큰설명", "tokenStatus": "CLOSED", "tokenContractSeq": 1, "tokenContractAddress": "test-addresss", "createdAt": "2021-09-04T11:17:24.000Z", "createdBy": null, "updatedAt": "2021-09-07T06:42:45.648Z", "updatedBy": "" }, "tokenUser": { "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": "2021-09-07T11:32:52.000Z", "updatedBy": null } } |
9. 토큰에서 토큰 사용자를 삭제(탈퇴)
토큰에서 토큰 사용자를 삭제한다. 토큰 사용자의 토큰 가입 상태를 CLOSED로 변경한 뒤 일정시간 경괴 후 삭제 절차를 수행합니다.
기본 정보
URI | /token/{tokenSeq}/member/{tokenUserId} |
---|---|
METHOD | DELETE |
Content-Type | - |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | number | tokenSeq | M | 1 | - | 토큰 일련번호 | |
string | tokenUserId | M | muge.ah | - | 삭제할 토큰 사용자 ID |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
User | string | userId | M | gildong.hong | 사용자 ID |
string | userName | M | 홍길동 | 사용자 이름 | |
string | organization | O | 인력팀 | 사용자 조직 | |
enum | userStatus | M | ACTIVATED | 사용자 상태 | |
string | createdAt | M | 2021-09-01T00:01:02.000Z | 생성 일시 |
Request Sample Code
curl -X 'DELETE' \ 'https://{{TOKEN-SERVICE-URL}}/user/info/gildong.hong' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' }' |
Response Sample Code
{ "tokenSeq": 1, "tokenUserId": "muge.ah", "isAdmin": false, "status": "CLOSED", "createdAt": "2021-09-06T23:06:15.000Z", "createdBy": "muge.ah", "updatedAt": null, "updatedBy": null, } |
10. 토큰 관리자를 변경
지정한 토큰의 관리자를 변경합니다.
기본 정보
URI | /token/admin/{tokenSeq}/admin |
---|---|
METHOD | PUT |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path | number | tokenSeq | M | 1 | - | 토큰 컨트랙트 seq (id) | |
body | ChangeTokenAdminInput | string | oldTokenAdminUserId | M | admin1 | - | 지정된 토큰 기존 관리자 Id |
string | newTokenAdminUserId | M | admin2 | - | 지정된 토큰 새 관리자 Id |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenMemberHistory | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | tokenName | M | My Token | 토큰 이름 | |
string | tokenSymbol | M | MT1 | 토큰 심볼 | |
string | tokenUserId | M | admin1 | 토큰 사용자 id | |
string | tokenUserName | O | 관리자 | 토큰 사용자 이름 | |
enum | opCode | M | GIVE_ADMIN | 작업 코드
| |
enum | opState | M | PENDING | 작업 상태 :
| |
number | opResult | C | 40400 | 작업 결과. (opState : PENDING 일때는 Null)
| |
string | opDetail | O | 토큰 관리자 변경 | 작업 상세 | |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
string | opBy | O | admin1 | 요청 사용자 id | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'PUT' \ 'http://localhost:3000/token/admin/22/admin' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "newTokenAdminUserId": "test-admin2", "oldTokenAdminUserId": "test-admin1" }' |
Response Sample Code
{ "opCode": "GIVE_ADMIN", "opDetail": "토큰 관리자 변경. {\"newTokenAdminUserId\":\"test-admin2\",\"oldTokenAdminUserId\":\"test-admin1\"}", "opState": "PENDING", "opBy": "test-admin1", "tokenSeq": 22, "tokenName": "LTNAME", "tokenSymbol": "LT1", "tokenUserId": "test-admin1", "tokenUserName": null, "opResult": null, "historySeq": "7", "opAt": "2021-09-06T02:47:09.259Z", "updatedAt": "2021-09-06T02:47:09.259Z" } |
토큰 서비스
1. 토큰 발행
토큰을 발행합니다.
기본 정보
URI | /token/tx/init |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | InitTokenDto | string | tokenAdminId | M | admin1 | - | 지정된 토큰 관리자 Id |
string | tokenName | M | My Token | - | 토큰 이름 | ||
string | tokenSymbol | M | MT1 | - | 토큰 심볼 | ||
number | tokenInitialSupply | O | 1000 | 0 | 토큰 초기 발행량 | ||
string | tokenInitialHolderId | O | admin1 | tokenAdminId | 토큰 초기 발행량을 가질 토큰 멤버 Id default : 관리자 Id | ||
string | tokenDescription | O | My first token | - | 토큰 추가 설명 | ||
string | comment | O | Deploy test | - | 작업 코멘트 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenHistorySeq | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | tokenName | M | My Token | 토큰 이름 | |
string | tokenSymbol | M | MT1 | 토큰 심볼 | |
number | tokenInitialSupply | M | 0 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | M | admin1 | 토큰 초기 발행량을 가질 토큰 멤버 Id | |
string | tokenDescription | O | My first token | 토큰 추가 설명 | |
string | tokenContractSeq | C | 1 | 토큰 컨트랙트 artifact 정보 id (opState : PENDING 일때는 Null) | |
string | tokenContractAddress | C | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 배포된 토큰 컨트랙트 주소 | |
enum | opCode | M | INIT | 작업 코드
| |
enum | opState | M | PENDING | 작업 상태 :
| |
number | opResult | C | 40400 | 작업 결과 (opState : PENDING 일때는 Null)
| |
string | opDetail | O | 토큰 작업 내용 | 작업 상세 | |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
string | opBy | O | admin1 | 요청 사용자 id | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/init' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenAdminId": "test-admin1", "tokenName": "DOCSTest", "tokenSymbol": "DT1", "tokenInitialSupply": 0 }' |
Response Sample Code
{ "tokenName": "DOCSTest", "tokenSymbol": "DT1",토큰을 생성한다. "tokenInitialSupply": 0, "tokenInitialHolderId": "test-admin1", "comment": null, "opCode": "INIT", "opBy": "test-admin1", "tokenDescription": null, "tokenSeq": null, "tokenContractSeq": null, "tokenContractAddress": null, "opResult": null, "opDetail": null, "historySeq": "57", "opState": "PENDING", "opAt": "2021-09-06T02:59:49.504Z", "updatedAt": "2021-09-06T02:59:49.504Z" } |
2. 토큰을 추가발행
토큰을 추가발행합니다.
기본 정보
URI | /token/tx/mint |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | MintTokenDto | string | tokenAdminId | M | admin1 | - | 지정된 토큰 관리자 Id |
number | tokenSeq | M | 1 | - | 토큰 seq (id) | ||
number | amount | M | 1000 | - | 토큰 추가 발행량 | ||
string | comment | O | mint test | - | 작업 코멘트 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenHistorySeq | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | tokenName | M | My Token | 토큰 이름 | |
string | tokenSymbol | M | MT1 | 토큰 심볼 | |
number | tokenInitialSupply | M | 0 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | M | admin1 | 토큰 초기 발행량을 가질 토큰 멤버 Id | |
string | tokenDescription | O | My first token | 토큰 추가 설명 | |
string | tokenContractSeq | M | 1 | 토큰 컨트랙트 artifact 정보 id | |
string | tokenContractAddress | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 배포된 토큰 컨트랙트 주소 | |
enum | opCode | M | MINT | 작업 코드
| |
enum | opState | M | PENDING | 작업 상태 :
| |
number | opResult | C | 40400 | 작업 결과 (opState : PENDING 일때는 Null)
| |
string | opDetail | O | 토큰 작업 내용 | 작업 상세 | |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
string | opBy | O | admin1 | 요청 사용자 id | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/mint' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenSeq": 23, "amount": 10, "tokenAdminId": "test-admin1", "comment": "afd" }' |
Response Sample Code
{ "tokenSeq": 23, "tokenName": "DOCSTest", "tokenSymbol": "DT1", "tokenInitialHolderId": "test-admin1", "tokenInitialSupply": 0, "tokenDescription": null, "tokenContractAddress": "0x93f59523f70A04C62bE67869c3F32b69D0bABC08", "tokenContractSeq": 2, "opCode": "MINT", "opBy": "test-admin1", "opResult": null, "opDetail": null, "comment": null, "historySeq": "58", "opState": "PENDING", "opAt": "2021-09-06T03:08:09.050Z", "updatedAt": "2021-09-06T03:08:09.050Z" } |
3. 토큰 소각
토큰을 소각합니다.
기본 정보
URI | /token/tx/burn |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | BurnTokenDto | string | tokenAdminId | M | admin1 | - | 지정된 토큰 관리자 Id |
number | tokenSeq | M | 1 | - | 토큰 seq (id) | ||
number | amount | M | 1000 | - | 토큰 소각량 | ||
string | comment | O | burn test | - | 작업 코멘트 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenHistorySeq | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | tokenName | M | My Token | 토큰 이름 | |
string | tokenSymbol | M | MT1 | 토큰 심볼 | |
number | tokenInitialSupply | M | 0 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | M | admin1 | 토큰 초기 발행량을 가질 토큰 멤버 Id | |
string | tokenDescription | O | My first token | 토큰 추가 설명 | |
string | tokenContractSeq | M | 1 | 토큰 컨트랙트 artifact 정보 id | |
string | tokenContractAddress | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 배포된 토큰 컨트랙트 주소 | |
enum | opCode | M | BURN | 작업 코드
| |
enum | opState | M | PENDING | 작업 상태 :
| |
number | opResult | C | 40400 | 작업 결과 (opState : PENDING 일때는 Null)
| |
string | opDetail | O | 토큰 배포 | 작업 상세 | |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
string | opBy | O | admin1 | 요청 사용자 id | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/burn' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenSeq": 24, "amount": 1, "tokenAdminId": "test-admin1", "comment": "fe" }' |
Response Sample Code
{ "tokenSeq": 24, "tokenName": "DOCSTest2", "tokenSymbol": "DT2", "tokenInitialHolderId": "test-admin1", "tokenInitialSupply": 0, "tokenDescription": null, "tokenContractAddress": "0xAC50aeaAb151b78F310c1CA40bFeC1F09a7EC248", "tokenContractSeq": 2, "opCode": "BURN", "opBy": "test-admin1", "opResult": null, "opDetail": null, "comment": null, "historySeq": "61", "opState": "PENDING", "opAt": "2021-09-06T03:14:06.084Z", "updatedAt": "2021-09-06T03:14:06.084Z" } |
4. 토큰을 사용중지 상태로 변경
토큰을 사용중지 상태로 변경합니다.
기본 정보
URI | /token/tx/pause |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | PauseTokenDto | string | tokenAdminId | M | admin1 | - | 지정된 토큰 관리자 Id |
number | tokenSeq | M | 1 | - | 토큰 seq (id) | ||
string | comment | O | burn test | - | 작업 코멘트 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenHistorySeq | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | tokenName | M | My Token | 토큰 이름 | |
string | tokenSymbol | M | MT1 | 토큰 심볼 | |
number | tokenInitialSupply | M | 0 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | M | admin1 | 토큰 초기 발행량을 가질 토큰 멤버 Id | |
string | tokenDescription | O | My first token | 토큰 추가 설명 | |
string | tokenContractSeq | M | 1 | 토큰 컨트랙트 artifact 정보 id | |
string | tokenContractAddress | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 배포된 토큰 컨트랙트 주소 | |
enum | opCode | M | PAUSE | 작업 코드
| |
enum | opState | M | PENDING | 작업 상태 :
| |
number | opResult | C | 40400 | 작업 결과 (opState : PENDING 일때는 Null)
| |
string | opDetail | O | 토큰 작업 내용 | 작업 상세 | |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
string | opBy | O | admin1 | 요청 사용자 id | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/pause' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenSeq": 24, "tokenAdminId": "test-admin1", "comment": "qwe" }' |
Response Sample Code
{ "tokenSeq": 24, "tokenName": "DOCSTest2", "tokenSymbol": "DT2", "tokenInitialHolderId": "test-admin1", "tokenInitialSupply": 0, "tokenDescription": null, "tokenContractAddress": "0xAC50aeaAb151b78F310c1CA40bFeC1F09a7EC248", "tokenContractSeq": 2, "opCode": "PAUSE", "opBy": "test-admin1", "opResult": null, "opDetail": null, "comment": null, "historySeq": "62", "opState": "PENDING", "opAt": "2021-09-06T03:17:24.864Z", "updatedAt": "2021-09-06T03:17:24.864Z" } |
5. 토큰을 사용가능 상태로 변경
토큰을 사용가능 상태로 변경합니다.
기본 정보
URI | /token/tx/unpause |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | UnpauseTokenDto | string | tokenAdminId | M | admin1 | - | 지정된 토큰 관리자 Id |
number | tokenSeq | M | 1 | - | 토큰 seq (id) | ||
string | comment | O | burn test | - | 작업 코멘트 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenHistorySeq | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | tokenName | M | My Token | 토큰 이름 | |
string | tokenSymbol | M | MT1 | 토큰 심볼 | |
number | tokenInitialSupply | M | 0 | 토큰 초기 발행량 | |
string | tokenInitialHolderId | M | admin1 | 토큰 초기 발행량을 가질 토큰 멤버 Id | |
string | tokenDescription | O | My first token | 토큰 추가 설명 | |
string | tokenContractSeq | M | 1 | 토큰 컨트랙트 artifact 정보 id | |
string | tokenContractAddress | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 배포된 토큰 컨트랙트 주소 | |
enum | opCode | M | UNPAUSE | 작업 코드
| |
enum | opState | M | PENDING | 작업 상태 :
| |
number | opResult | C | 40400 | 작업 결과 (opState : PENDING 일때는 Null)
| |
string | opDetail | O | 토큰 작업 내용 | 작업 상세 | |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
string | opBy | O | admin1 | 요청 사용자 id | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/unpause' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenSeq": 24, "tokenAdminId": "test-admin1", "comment": "tyr" }' |
Response Sample Code
{ "tokenSeq": 24, "tokenName": "DOCSTest2", "tokenSymbol": "DT2", "tokenInitialHolderId": "test-admin1", "tokenInitialSupply": 0, "tokenDescription": null, "tokenContractAddress": "0xAC50aeaAb151b78F310c1CA40bFeC1F09a7EC248", "tokenContractSeq": 2, "opCode": "UNPAUSE", "opBy": "test-admin1", "opResult": null, "opDetail": null, "comment": null, "historySeq": "63", "opState": "PENDING", "opAt": "2021-09-06T03:18:49.568Z", "updatedAt": "2021-09-06T03:18:49.568Z" } |
6. 토큰을 전송 (Token 관리자용)
Token 관리자가 token 사용자에게 토큰을 전송합니다.
기본 정보
URI | /token/tx/transfer |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | TransferTokenDto | string | senderId | M | admin1 | - | 지정된 토큰 관리자 Id |
string | receiverId | M | user1 | - | 토큰을 받을 사용자 Id | ||
number | amount | M | 100 | - | 전송할 양 | ||
number | tokenSeq | M | 1 | - | 토큰 seq (id) | ||
string | comment | O | burn test | - | 작업 코멘트 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
TokenTransferHistorySeq | number | historySeq | M | 1 | 히스토리 seq (id) |
number | tokenSeq | M | 1 | 토큰 seq (id) | |
string | senderId | M | admin1 | 토큰 전송할 Id | |
boolean | senderIsAdmin | M | true | 토큰 전송할 계정이 해당 토큰의 관리자인지 여부 | |
string | senderAddress | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 토큰 전송할 id 의 주소 | |
string | recipientId | M | user1 | 토큰 수령할 Id | |
boolean | recipientIsAdmin | M | false | 토큰 수령할 계정이 해당 토큰의 관리자인지 여부 | |
string | recipientAddress | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 토큰 수령할 id 의 주소 | |
number | amount | M | 10 | 토큰 전송 양 | |
enum | transferCode | M | TRANSFER | 작업 코드
| |
enum | transferState | M | PENDING | 작업 상태 :
| |
number | transferResult | C | 40400 | 작업 결과 (opState : PENDING 일때는 Null)
| |
datetime | opAt | M | 2021-09-06T02:40:18.654Z | 요청 일시 | |
datetime | updatedAt | M | 2021-09-06T02:40:18.654Z | 마지막 업데이트 일시 |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/transfer' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenSeq": 24, "amount": 1, "senderId": "test-admin1", "receiverId": "test-admin2", "comment": "stri11" }' |
Response Sample Code
{ "tokenSeq": 24, "senderId": "test-admin1", "senderAddress": "0x015786A259035a7ff0BDD8A77AAC25f6C3A5FF73", "senderIsAdmin": true, "recipientId": "test-admin2", "recipientAddress": "0xee188c31B163ad11a7c180Fb4F0342D2e2575A53", "recipientIsAdmin": false, "amount": 1, "transferCode": "TRANSFER", "transferState": "PENDING", "transferResult": null, "historySeq": "7", "opAt": "2021-09-06T03:28:10.351Z", "updatedAt": "2021-09-06T03:28:10.351Z" } |
7. 클라이언트에서 서명할 수 있도록 토큰전송 raw transaction object 생성
클라이언트에서 서명할 수 있도록 토큰전송 raw transaction object를 만들어 줍니다.
기본 정보
URI | /token/tx/raw/object/transfer |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | All |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | CreateRawTxObjectForTransferInput | string | senderId | M | admin1 | - | 지정된 토큰 관리자 Id |
string | receiverId | M | user1 | - | 토큰을 받을 사용자 Id | ||
number | amount | M | 100 | - | 전송할 양 | ||
number | tokenSeq | M | 1 | - | 토큰 seq (id) |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
RawTxObjectOutput | string | from | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | sender 주소 |
string | to | M | 0x93f59523f70A04C62bE67869c3F32b69D0bABC08 | 토큰 컨트랙트 주소 | |
number | nonce | M | 1 | nonce | |
gas | M | 6721975 | gas | ||
number | gasPrice | M | 0 | gasPrice | |
string | data | M | 0xa9059cbb000000000000000000000000ee188c31b163ad11a7c180fb4f0342d2e2575a530000000000000000000000000000000000000000000000000000000000000001 | hex encoded data |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/raw/object/transfer' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "tokenSeq": 24, "senderId": "test-admin1", "receiverId": "test-admin2", "amount": 1 }' |
Response Sample Code
{ "from": "0x015786A259035a7ff0BDD8A77AAC25f6C3A5FF73", "to": "0xAC50aeaAb151b78F310c1CA40bFeC1F09a7EC248", "data": "0xa9059cbb000000000000000000000000ee188c31b163ad11a7c180fb4f0342d2e2575a530000000000000000000000000000000000000000000000000000000000000001", "gas": 6721975, "gasPrice": 0, "nonce": 46 } |
8. 클라이언트에서 서명한 Serialized signed transaction 을 블록체인에 전송
클라이언트에서 서명한 Serialized signed transaction 을 블록체인에 전송합니다.
기본 정보
URI | /token/tx/signed |
---|---|
METHOD | POST |
Content-Type | application/json |
Role | All |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | SendSignedTransactionInput | string | serializedSignedTx | M | 0xasdfef | - | 클라이언트에서 서명해 hex 인코딩 된 serialized signed transaction |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
Object | M | { "blockHash" : 0xaf01...., "transactionHash" : 0x10afefe..... .... } | 트랜잭션 receipt |
Request Sample Code
curl -X 'POST' \ 'http://localhost:3000/token/tx/signed' \ -H 'accept: */*' \ -H 'Content-Type: application/json' \ -d '{ "serializedSignedTx": "0xf8a50380836691b794ac50aeaab151b78f310c1ca40bfec1f09a7ec24880b844a9059cbb000000000000000000000000015786a259035a7ff0bdd8a77aac25f6c3a5ff7300000000000000000000000000000000000000000000000000000000000000011ca064453e7bae68f3132b59da52f168100ab437d2679e081155be324980bb50e6a7a042feabef392d5f16930a93bf6a660f1eb5dfed951beb3e8c3592f0d3e3ec8cc9" }' |
Response Sample Code
{ "blockHash": "0x3a2208e5a439a93a5a8b5d9f81ee454c8551ef0a62ec018d7fcab33c062c8ffb", "blockNumber": 14773476, "contractAddress": null, "cumulativeGasUsed": 23581, "from": "0x46a84c5c22c49ee8c0e0231bc41a96ef8dd80cba", "gasUsed": 23581, "logs": [ { "address": "0xAC50aeaAb151b78F310c1CA40bFeC1F09a7EC248", "topics": [ "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x00000000000000000000000046a84c5c22c49ee8c0e0231bc41a96ef8dd80cba", "0x000000000000000000000000015786a259035a7ff0bdd8a77aac25f6c3a5ff73" ], "data": "0x0000000000000000000000000000000000000000000000000000000000000001", "blockNumber": 14773476, "transactionHash": "0x0fa0d3dea37e8b27e9f93be3cea3473974802579f8d080ef9926ad7e39438f00", "transactionIndex": 0, "blockHash": "0x3a2208e5a439a93a5a8b5d9f81ee454c8551ef0a62ec018d7fcab33c062c8ffb", "logIndex": 0, "removed": false, "id": "log_02ba7fb3" } ], "logsBloom": "0x00000000000000000000000000400000000000000000000000000000000000000000000000400000010000000000000000000004000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000010010001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000", "status": true, "to": "0xac50aeaab151b78f310c1ca40bfec1f09a7ec248", "transactionHash": "0x0fa0d3dea37e8b27e9f93be3cea3473974802579f8d080ef9926ad7e39438f00", "transactionIndex": 0 } |
8. 트랜잭션 해시값으로 트랜잭션 receipt (처리결과)조회
클라이언트에서 서명한 Serialized signed transaction 을 블록체인에 전송합니다.
기본 정보
URI | /token/tx/signed/receipt/{txHash} |
---|---|
METHOD | GET |
Content-Type | application/json |
Role | All |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path | string | txHash | M | 0xasdfef | - | 블록체인 트랜잭션 해시 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
Object | M | { "blockHash" : 0xaf01...., "transactionHash" : 0x10afefe..... .... } | 트랜잭션 receipt |
Request Sample Code
curl -X 'GET' \ 'http://localhost:3000/token/tx/signed/receipt/0x0fa0d3dea37e8b27e9f93be3cea3473974802579f8d080ef9926ad7e39438f00' \ -H 'accept: */*' |
Response Sample Code
{ "blockHash": "0x3a2208e5a439a93a5a8b5d9f81ee454c8551ef0a62ec018d7fcab33c062c8ffb", "blockNumber": 14773476, "contractAddress": null, "cumulativeGasUsed": 23581, "from": "0x46a84c5c22c49ee8c0e0231bc41a96ef8dd80cba", "gasUsed": 23581, "logs": [ { "address": "0xAC50aeaAb151b78F310c1CA40bFeC1F09a7EC248", "topics": [ "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "0x00000000000000000000000046a84c5c22c49ee8c0e0231bc41a96ef8dd80cba", "0x000000000000000000000000015786a259035a7ff0bdd8a77aac25f6c3a5ff73" ], "data": "0x0000000000000000000000000000000000000000000000000000000000000001", "blockNumber": 14773476, "transactionHash": "0x0fa0d3dea37e8b27e9f93be3cea3473974802579f8d080ef9926ad7e39438f00", "transactionIndex": 0, "blockHash": "0x3a2208e5a439a93a5a8b5d9f81ee454c8551ef0a62ec018d7fcab33c062c8ffb", "logIndex": 0, "removed": false, "id": "log_02ba7fb3" } ], "logsBloom": "0x00000000000000000000000000400000000000000000000000000000000000000000000000400000010000000000000000000004000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000010010001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000008000000000000", "status": true, "to": "0xac50aeaab151b78f310c1ca40bfec1f09a7ec248", "transactionHash": "0x0fa0d3dea37e8b27e9f93be3cea3473974802579f8d080ef9926ad7e39438f00", "transactionIndex": 0 } |
토큰 사용자 관리
1. 토큰 사용자 추가
서비스 사용자(토큰 관리자)를 추가합니다.
기본 정보
URI | /token/user/info |
---|---|
METHOD | PUT |
Content-Type | application/json |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | CreateUserDto | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID |
string | tokenUserName | M | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 권한 owned address |
Response Parameter
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID | |
string | tokenUserName | M | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address | ||
string | tokenUserStatus | M | ACTIVE | - | 토큰 사용자 상태 | ||
string | createdAt | M | 2021-09-01T00:01:02.000Z | - | 생성 일시 | ||
string | createdBy | O | muge.ah | 생성자 ID | |||
string | updatedAt | O | 수정 일시 | ||||
string | updatedBy | O | 수정자 ID |
Request Sample Code
curl -X 'PUT' \ 'https://{{TOKEN-SERVICE-URL}}/token/user/info' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \ -d '{ "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e" }' |
Response Sample Code
{ "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "createdBy": null, "updatedAt": null, "updatedBy": null, "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z" } |
2. 토큰 사용자 목록 조회
서비스 사용자(토큰 관리자) 목록을 조회합니다.
기본 정보
URI | /user/info |
---|---|
METHOD | PUT |
Content-Type | application/json |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
query | string | tokenUserId | O | gildong.hong | - | 토큰 사용자 ID | |
string | tokenUserName | O | 홍길동 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 인력팀 | - | 토큰 사용자 조직, 부분 조회 허용 | ||
string | tokenUserOwnedAddress | O | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address | ||
number | skip | O | 0 | 0 | skip row count | ||
number | take | O | 10 | 10 | take row count | ||
string | sort | O | organization | - | 정렬 대상 컬럼명 | ||
string | order | O | DESC | - | 정렬 순서 |
Response Parameter
Type | Name | M / C / O | Example | Description | |
---|---|---|---|---|---|
Pagenate<TokenUser> | number | total | M | 18 | 대상 전체 수 |
number | skip | M | 0 | skip row count | |
number | take | M | 10 | take row count | |
number | count | O | 5 | current row count | |
TokenUser[] | contents | O | [ ] | 토큰 사용자 목록 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/user/info?tokenUserId=muge.ah' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
{ "total": 1, "skip": 0, "take": 10, "contents": [ { "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": null, "updatedBy": null } ] } |
3. ID를 이용하여 토큰 사용자 상세 정보를조회한다.
서비스 사용자(토큰 관리자)의 상세 정보를 조회한다.
기본 정보
URI | /token/user/info/{tokenUserId}/by-id |
---|---|
METHOD | GET |
Content-Type | - |
Role | All |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID |
Response Parameter
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID | |
string | tokenUserName | M | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address | ||
boolean | isAdmin | M | true | - | 토큰 사용자 상태 | ||
string | joinedAt | O | 2021-09-02T00:01:02.000Z | - | 토큰 가입 일시 | ||
string | createdAt | M | 2021-09-01T00:01:02.000Z | - | 생성 일시 | ||
string | createdBy | O | muge.ah | - | 생성자 ID | ||
string | updatedAt | O | - | 수정 일시 | |||
string | updatedBy | O | - | 수정자 ID | |||
UsingTokenDto[] | tokens | O | [ ] | - | 가입중인 토큰 목록 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/user/info/muge.ah/by-id' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
{ "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": null, "updatedBy": null, "tokens": [] } |
4. Owned address를 이용하여 토큰 사용자 상세 정보 조회
서비스 사용자(토큰 관리자)의 상세 정보를 조회합니다.
기본 정보
URI | /token/user/info/{tokenUserOwnedAddress} |
---|---|
METHOD | GET |
Content-Type | - |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자의 owned address |
Response Parameter
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID | |
string | tokenUserName | M | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address | ||
boolean | isAdmin | M | true | - | 토큰 사용자 상태 | ||
string | joinedAt | O | 2021-09-02T00:01:02.000Z | - | 토큰 가입 일시 | ||
string | createdAt | M | 2021-09-01T00:01:02.000Z | - | 생성 일시 | ||
string | createdBy | O | muge.ah | - | 생성자 ID | ||
string | updatedAt | O | - | 수정 일시 | |||
string | updatedBy | O | - | 수정자 ID | |||
UsingTokenDto[] | tokens | O | [ ] | - | 가입중인 토큰 목록 |
Request Sample Code
curl -X 'GET' \ 'https://{{TOKEN-SERVICE-URL}}/token/user/info/0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e/by-oa' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
{ "tokenUserId": "muge.ah", "tokenUserName": "아무개", "tokenUserOrganization": "홍보팀", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": null, "updatedBy": null, "tokens": [] } |
5. 토큰 사용자 정보를 변경합니다.
서비스 사용자(토큰 관리자)의 정보를 변경합니다.
기본 정보
URI | /token/user/info/{userId} |
---|---|
METHOD | PATCH |
Content-Type | application/json |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | string | tokenUserId | M | muge.ah | - | 변경할 대상 토큰 사용자 ID | |
Body | string | tokenUserName | O | 변경된아무개 | - | 변경할 토큰 사용자 이름 | |
string | tokenUserOrganization | O | 변경된부서명 | - | 변경할 토큰 사용자 조직 |
Response Parameter
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID | |
string | tokenUserName | M | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address | ||
string | tokenUserStatus | M | ACTIVE | - | 토큰 사용자 상태 | ||
string | createdAt | M | 2021-09-01T00:01:02.000Z | - | 생성 일시 | ||
string | createdBy | O | muge.ah | 생성자 ID | |||
string | updatedAt | O | 수정 일시 | ||||
string | updatedBy | O | 수정자 ID |
Request Sample Code
curl -X 'PATCH' \ 'https://{{TOKEN-SERVICE-URL}}/token/user/info/muge.ah' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \ -d '{ "tokenUserName": "변경된아무개", "tokenUserOrganization": "변경된부서명" }' |
Response Sample Code
{ "tokenUserId": "muge.ah", "tokenUserName": "변경된아무개", "tokenUserOrganization": "변경된부서명", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "ACTIVE", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": "2021-09-07T07:41:00.950Z", "updatedBy": null } |
6. 토큰 사용자 삭제
서비스 사용자(토큰 관리자)를 삭제합니다. 사용자의 상태를 CLOSED로 변경한 뒤 일정시간 경괴 후 삭제 절차를 수행합니다.
기본 정보
URI | /token/user/info/{userId} |
---|---|
METHOD | DELETE |
Content-Type | - |
Role | ADMIN, TOKEN_ADMIN |
Request Parameters
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
path variable | string | userId | M | gildong.hong | - | 변경할 대상 사용자 ID |
Response Parameter
Parameter Type | Type | Name | M / C / O | Example | Default | Description | |
---|---|---|---|---|---|---|---|
body | string | tokenUserId | M | muge.ah | - | 토큰 사용자 ID | |
string | tokenUserName | M | 아무개 | - | 토큰 사용자 이름 | ||
string | tokenUserOrganization | O | 홍보팀 | - | 토큰 사용자 조직 | ||
string | tokenUserOwnedAddress | M | 0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e | - | 토큰 사용자 owned address | ||
string | tokenUserStatus | M | ACTIVE | - | 토큰 사용자 상태 | ||
string | createdAt | M | 2021-09-01T00:01:02.000Z | - | 생성 일시 | ||
string | createdBy | O | muge.ah | 생성자 ID | |||
string | updatedAt | O | 수정 일시 | ||||
string | updatedBy | O | 수정자 ID |
Request Sample Code
curl -X 'DELETE' \ 'https://{{TOKEN-SERVICE-URL}}/token/user/info/muge.ah' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {{ACCESS-TOKEN}}' |
Response Sample Code
{ "tokenUserId": "muge.ah", "tokenUserName": "변경된아무개", "tokenUserOrganization": "변경된부서명", "tokenUserOwnedAddress": "0x785ac7B77eFe4C561174Fd4Ea3F4372f1630083e", "tokenUserStatus": "CLOSED", "createdAt": "2021-09-06T21:58:26.000Z", "createdBy": null, "updatedAt": "2021-09-07T07:41:00.950Z", "updatedBy": null } |