Rest APIs

Integrating REST APIs into CI / CD pipelines #

This article describes how to use the apptest.ai with CI(Continuous Integration) tools. You can use apptest.ai with the test creation, status view, and result view APIs.

1. [POST] Run New Testset #

This Run New Testset allows you to create a TestSet and run. Testset is a group of unit Tests.
Some options for the new test run follow the configuration information stored in the specific project.

[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 #

Check the progress of the testset

[ 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 #

This API can be called only when the test is completed. Returns the result data of the testset.

[ 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 #

This is an API to get the scenario information to be used when running the scenario test.

[ 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 #