Rest API’s

Integrating REST APIs into CI / CD pipelines #

CI (Continuous Integration) 도구과 연동하여 apptest.ai를 사용하기위한 API 정보를 제공합니다. 해당 문서에서 제공되는 테스트시작, 테스트 상태 보기, 테스트 결과 조회 API를 통해 apptest.ai를 사용하실 수 있습니다.

1. [POST] Run New Testset #

새로운 테스트 세트를 생성합니다. (테스트 세트는 단위 테스트들의 집합입니다.) 새로운 테스트기 실행될때 사용되는 일부 옵션들은 프로젝트에 미리 저장해놓은 설정 정보를 따릅니다. [Request]

POST /openapi/v2/testset

Host : https://api.apptest.ai

Authorization : Basic {user_id}:{access_key}

Request Body Multipart Form Data #1

Request Body Multipart Form Data #2

[ Request Example #1 – Automated Test]

curl    --request POST \
        --user {user_id}:{access_key} \
        -F 'app_file=@/path/of/your/app_file' \
        -F 'data={\
            "pid": 509, \
            "testset_name": "Testset Name Example #1", \
            "os_type": "ANDROID", \
            "time_limit": 15, \
            "use_vo": false, \
            "credentials": { \
                "login_id": "test@gmail.com", \
                "login_pw": "password1234!" \
            } \
        }' https://api.apptest.ai/openapi/v2/testset

[ Request Example #2 – Scenario Test]

curl    --request POST \
        --user {user_id}:{access_key} \
        -F 'data={\
            "pid": 509, \
            "testset_name": "Testset Name Example #1", \
            "os_type": "ANDROID", \
            "scenario_id": 1204, \
            "source_type": "file", \
            "time_limit": 15, \
        }' https://api.apptest.ai/openapi/v2/testset

[ Response ]

[ Response Example ]

{
  "data": {
    "test_count": 1,
    "testset_id": 251929
  },
  "result_code": 0,
  "result_msg": "",
  "reason": ""
}

[ Error Code ]

2. [ GET ] Testset Status #

테스트 세트의 진행상황 확인

[ Request ]

GET /openapi/v2/testset/{testset_id}

Host : https://api.apptest.ai

Authorization : Basic {user_id}:{access_key}

Request URL Parameter

[ Request Example ]

curl --request GET \
     --user {user_id}:{access_key} \
     https://api.apptest.ai/openapi/v2/testset/55716

[ Response ]

Response Body Data Type : JSON

[Response Example ]

{
  "data": {
    "testset_status": "Complete",
    "testset_status_detail": {
      "total_test_cnt": 3,
      "error_cnt": 1,
      "fail_cnt": 1,
      "initializing_cnt": 0,
      "running_cnt": 1,
      "stop_cnt": 0,
      "pass_cnt": 0
    },
    "response_time": "Mon, 25 May 2020 06:40:24 GMT"
  },
  "result_code": 0,
  "result_msg": "",
  "reason": ""
}

[ Error Code ]

3. [ GET ] Testset Result #

테스트가 완료되었을 경우에만 호출이 가능한 API 입니다. 테스트 세트의 결과 데이터를 조회합니다.

[ Request ]

GET /openapi/v2/testset/{testset_id}/result

Host : https://api.apptest.ai

Authorization : Basic {user_id}:{access_key}

Request URL Parameter

Request Query Parameter

curl --request GET \
     --user {user_id}:{access_key} \
     https://api.apptest.ai/openapi/v2/testset/55716/result

curl --request GET \
     --user {user_id}:{access_key} \
     https://api.apptest.ai/openapi/v2/testset/55716/result?data_type=xml

<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="TestBot Test">
    <testsuite name="{PROJECT NAME}.TestBot">
        <testcase name="{DEVICE NAME}" time="{TEST TIME SECONDS}">
            <system-out>{RESULT PAGE LINK URL}</system-out>
        </testcase>
        <testcase name="{DEVICE NAME}" time="{TEST TIME SECONDS}">
            <error message="{RESULT PAGE LINK URL}" />
        </testcase>
    </testsuite>
</testsuites>

4. [ GET ] List of Scenario IDs #

시나리오 테스트 실행 시 사용될 시나리오 정보를 조회하기 위한 API 입니다.

[ Request ]

GET /openapi/v2/project/{project_id}/scenarios

Host : https://api.apptest.ai

Authorization : Basic {user_id}:{access_key}

Request URL Parameter

Request Query Parameter

[ Request Example ]

curl --request GET \
     --user {user_id}:{access_key} \
     https://api.apptest.ai/openapi/v2/project/2019/scenarios?os_type=ANDROID&q=login_fail

[ Response ]

Response Body Data Type : JSON

[ Response Example ]

{
  "data": {
    "scenarios": [1204, 1206],
    "response_time": "Mon, 25 May 2020 06:40:24 GMT"
  },
  "result_code": 0,
  "result_msg": 0,
  "reason": ""
}

[ Error Code ]

Appendix. API Result Codes #