API

A lot of people ask us about a Hiptest REST API. It is planned here: https://trello.com/c/7tZThtdJ/221-rest-apis.

Until all this is done, you can already use web requests to get some data. Don’t hesitate to ask other resources in the Hiptest live chat.

URI Structure

To use this web API, your application will make an HTTPS request and parse the response. This API use JSON as its communication format and the standard HTTP methods GET.

URI should have the following structure:

https://hiptest.net/publication/<your_project_secret_token>/<resource_name>

With Hiptest on-premises, you should replace https://hiptest.net by your server path.

  • your_project_secret_token is the project secret token that you can find in the settings tab:Sélection_022
  • resource_name: choose a resource among the ones listed below

Resources

Test results

test_runs

Give all the test runs of the project

Example of url

https://hiptest.net/publication/00000000/test_runs

Response

{
  "test_runs": [
    {
      "id": "42",
      "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Sprint 2",
      "created_at": "2016-06-21T19:26:41.696Z",
      "archived": false
    },
    {
       "id": "7",
       "uid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
       "name": "Sprint 1",
       "created_at": "2016-04-12T14:00:35.064Z",
       "archived": true
    }
  ]
}

test_runs/<test_run_id>/test_results

Give the test results of the given test run:

  • test_run_id: id of the test run.

Example of url

https://hiptest.net/publication/00000000/test_runs/42/test_results

Response

{
  "passed_count": 5,
  "failed_count": 2,
  "retest_count": 1,
  "undefined_count": 10,
  "blocked_count": 0,
  "skipped_count": 3,
  "wip_count": 0
}