SBM JSON API 활용하기

SBM11부터 JSON API를 제공함에 따라 GET/POST 호출로 CRUD를 수행할 수 있습니다.

GET Functions

• GetItem

• GetItemsByItemID

• GetItemsByListingReport

• GetItemsByReportFilter

• GetItemTransitions

• GetVersion

POST Functions

• FinishTransition

• StartSubmitToAux

• StartSubmitToProject

• StartTransition

• SubmitToAux

• SubmitToProject

JSON API 호출을 할 때 SBM 사용자 정보를 전달을 해야하는데 기본 인증(Basic Authentication) 방식을 이용해도 되고, 만약 Single Sign-On을 이용하도록 구성되어 있다면 security token을 이용해야 합니다.

Security Token 요청하기:

1. POST방식으로 TokenService를 호출한다.

http://SSOHostName:8085/idp/services/rest/TokenService/

2. 다음과 같이 헤더 정보를 넘겨준다.

• Content-Type: application/json;charset=UTF-8
• Accept: application/json

3. 인증정보를 포함한다.

{"credentials": { "username" : "bill", "password":"mypassword"}}

예제:

Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 56
Source message

POST /idp/services/rest/TokenService/ HTTP/1.1
HOST: SSOHostName:8085
content-type: application/json;charset=UTF-8
accept: application/json
content-length: 56
 
 {"credentials": { "username" : "bill", "password":"mypassword"}}

인증이 성공하면 response 정보가 리턴된다.

{
"status": "OK"
"lifetime": {
"created": 1467228623885
"expires": 1467257423885
}
"token": {
"tokenType": "SSO"
"encoding": "base64"
"value": "PHNhbWw6QXNzZXJ0...pBc3NlcnRpb24+"

value 항목의 토큰 값은 base64 인코딩된 것이며, 이를 HTTP header에 ALFSSOAuthNToken 이름으로 값을 전달하면 JSON API call 인증 단계가 처리됩니다.

다음은 Firefox 브라우저 부가기능 RESTClient를 활용한 SBM JSON API 테스트 예제입니다.

1. POST 방식 선택, TokenService URL, Header 및 Body 값을 입력하여 SEND 실행. Response Body에서 리턴된 토큰 값을 확인할 수 있다.

2. 리턴된 토큰값을 ALFSSOAuthNToken Header 이름으로 값으로 추가한다. GET방식의 JSON API를 호출하면 정상적으로 값을 불러온다.

기타 다른 자세한 설명은 다음 도움말 웹사이트에서 확인가능합니다. JSON API Guide