이 섹션에서는 Airfob Portal API를 통해 사용자 로그인과 관리하는 방법을 설명합니다. |
에어팝 포탈 API를 사용하려면 사전에 에어팝 포탈 계정과 사이트를 생성해야합니다. 포탈 사이트 가입 및 생성 방법에 대한 자세한 내용은 아래 링크를 참조하십시오. |
시스템은 로그인 후 '토큰 값'을 가져 와서 다음 API 요청과 함께 Authroization 헤더에서 전달자로 사용해야합니다. 각 토큰의 유효 기간은 1시간입니다. 만료되면 새 토큰을 얻고 추가 API 요청을 위해 전달자 토큰을 새 토큰으로 변경해야합니다. |
api.mc.mocainc.com
URL: /login 방법: POST 요청 |
||||||||||||||||
|
응답 |
||||||||||||||||||||||||||||
|
예제 |
POST - /login
Request:
{"email": "api@mocainc.com", "password": "moca1!system"}
Response:
{"status":200,"message":"success",
"record":{
"email":"api.mocainc.com",
"accountType":"sitemanager",
"accessToken":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhYyI6InNpdGVtYW5hZ2VyIiwiZW0iOiJjaGFybGVzQHN1cHJlbWEuY28ua3IiLCJleHAiOjE1Njk4MDYxNTYsImlhdCI6MTU2OTgwMjU1Nn0.1QR22Y41kEoHwwWbkrq5BJwcfg4OyWszkSgLIUT18Zw",
"name":"TestUser",
"accountStatus":"ACTIVATED"
}
}
사용자와 카드 생성은 동시에 실행 가능합니다. | |
카드 타입은 사이트의 카드 타입에 따라 자동으로 할당됩니다. | |
만약 사이트가 레귤러를 사용하도록 설정되어 있으면 레귤러 카드가 발급됩니다. |
|
만약 사이트가 다이나믹을 사용하도록 설정되어 있으면 다이나믹 카드가 발급됩니다. 에어팝 서비스 설정된 사이트에도 동일하게 적용됩니다. |
URL: /user/card 방법: POST 요청 |
||||||||||||||||||||||||||||||||||||||||||||||||
|
응답 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
예제 |
POST - /user/card
Request:
{"siteId": "0",
"user": {
"userKey": "1",
"email": "moca@mocainc.com",
"phone":"+821022223333",
"meta":"{\"name\":\"모카\",\"department\":\"모바일\",\"title\":\"팀원\"}",
"portraitData":"BASE64ENCODED-BINARY",
"feedType": "EMAIL"
},
"card": {
"number":"8352800",
"startDate":1587778190617,
"endDate":1587778250617
}
}
Response:
{"status":200,"message":"success",
"record": {
"userId":"3",
"userKey":"1",
"email":"moca@mocainc.com",
"phone":"+821022223333",
"meta":"{\"name\":\"모카\",\"department\":\"모바일\",\"title\":\"팀원\"}",
"portrait":"https://IMG-URL",
"feedType":"EMAIL",
"card":{
"id":"43548",
"number":"8352800",
"status":"INACTIVE",
"cardType":"DYNAMIC",
"format":"GENERAL",
"cardTypeDesc":"GENERAL",
"startDate":1587778190617,
"endDate":1587778250617}
}
}
}
URL: /users/search 방법: POST 요청 |
||||||||||||||||||||||||||||
|
응답 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
예제 |
POST - /users/search
Request:
{"siteId": "0"}
Response:
{"status":200,"message":"success","total":"1",
"records":[
{"userId":"3",
"userKey":"1",
"email":"moca@mocainc.com",
"phone":"+821022223333",
"meta":"{\"name\":\"모카\",\"department\":\"모바일\",\"title\":\"팀원\"}",
"portrait":"https://IMG-URL",
"feedType":"EMAIL",
"card":{
"id":"43548",
"number":"8352800",
"status":"INACTIVE",
"cardType":"DYNAMIC",
"format":"GENERAL",
"cardTypeDesc":"GENERAL",
"startDate":1587778190617,
"endDate":1587778250617}
}
]
}
URL: /users/delete 방법: POST 요청 - 목록 |
||||||||||||
|
응답 |
||||||||||||||||
|
예제 |
POST - /users/delete
Request:
[{"userId": "303"},
{"userId": "304"}
]
Response:
{"status":207,"message":"Multi-Status",
"total":"2","success":"2","failure":"0",
"records":[
{"status":200,"message":"success"},
{"status":200,"message":"success"}
]
}
카드를 삭제하려면 상태 값이 'FORCE_DELETE'여야합니다. |
URL: /cards 방법: PUT 요청 - 목록 |
||||||||||||||||
|
응답 |
||||||||||||||||||||
|
예제 |
PUT - /cards
Request:
[{"cardId": "202"
"status": "FORCE_DELETE"},
{"cardId": "203",
"status": "FORCE_DELETE"}
]
Response:
{"status":207,"message":"Multi-Status",
"total":"2","success":"2","failure":"0",
"records":[
{"status":200,"message":"success",
"record": {"status": "DELETE"}},
{"status":200,"message":"success",
"record": {"status": "DELETE"}}
]
}
재전송은 다운로드 링크를 다시 전송하기위한 것입니다. 따라서 카드가 이미 활성화 된 상태에서는 처리 할 수 없습니다. |
URL: /card/send 방법: POST 요청 |
||||||||||||||||||||
|
응답 |
||||
- 없음 |
예제 |
POST - /card/send
Request:
{"siteId": "0", "number": "43548"}
Response:
{"status":200,"message":"success"}
재발급은 동일한 모바일 카드 데이터 재전송을 하기 위한 것입니다. 따라서 사용자와 카드 데이터를 수정할 수 없습니다. |
URL: /user/card 방법: PUT 요청 |
||||||||||||||||||||||||||||||||||||||||||||||||
|
응답 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
예제 |
PUT - /user/card
Request:
{"siteId": "0",
"userId" : "3",
"card": {
"startDate":1587778190617,
"endDate":1587778250617}
}
}
Response:
{"status":200,"message":"success",
"record": {
"userId":"3",
"userKey":"1",
"email":"moca@mocainc.com",
"phone":"+821022223333",
"meta":"{\"name\":\"모카\",\"department\":\"모바일\",\"title\":\"팀원\"}",
"portrait":"https://IMG-URL",
"feedType":"EMAIL",
"card":{
"id":"43548",
"number":"8352800",
"status":"INACTIVE",
"cardType":"DYNAMIC",
"format":"GENERAL",
"cardTypeDesc":"GENERAL",
"startDate":1587778190617,
"endDate":1587778250617}
}
}
}