API

Получение ключа

Для запроса к api необходим ключ. Получить его можно на странице профиля. Нажмите "Сгенерировать", если ключа еще нет. После нажатия будет сгенерирована строка из 32 символов. Если нажать "Обновить" - будет сгенерирован новый ключ и старый станет не валидным.

Для проверки ключа запросите свой профиль по адресу: https://api.testoid.io/user/me/profile/?apiKey=<apiKey>

Curl запрос:

curl -X GET 'https://api.testoid.io/user/me/profile/?apiKey=<apiKey>'

В ответе вернутся данные своего профиля:

{
  "user_name":"Иван",
  "phone":"+79112223344",
  "telegram_chat_id":1,
  "telegram_notification":1,
  "email_notification":0,
  "api_key":"VyoSum535824BvJvhmMb1x9NyyNN_5xq",
  "limit": {
    "count_organizations":0,
    "count_test_runs_per_month":1000000,
    "total_test_runs_per_month":2893
  }
}

Запуск теста

Тест запускается по его id. Его можно узнать на странице теста, например для https://app.testoid.io/test/1 id будет равен 1. Для запуска теста нужно сделать POST запрос на адрес https://api.testoid.io/test/<testId>/run/?apiKey=<apiKey>

Curl запрос:

curl -X POST 'https://api.testoid.io/test/<testId>/run/?apiKey=<apiKey>'

В ответе вернется новый статус теста

{"status":"queue"}

Запуск группы тестов

Группа тестов запускается по id. Его можно узнать на странице группы тестов, например для https://app.testoid.io/suite/1 id будет равен 1. Для запуска нужно сделать POST запрос на адрес https://api.testoid.io/suite/<suiteId>/run/?apiKey=<apiKey>

Curl запрос:

curl -X POST 'https://api.testoid.io/suite/<suiteId>/run/?apiKey=<apiKey>'

В ответе вернется новый статус группы тестов

{"status":"queue"}

Запуск всех тестов организации

Тесты организации запускаются по id организации. Его можно узнать на странице редактирования организации в профиле пользователя, например для https://app.testoid.io/organization/1 id будет равен 1. Для запуска нужно сделать POST запрос на адрес https://api.testoid.io/suite-group/organization/1/run/?apiKey=<apiKey>

Curl запрос:

curl -X POST 'https://api.testoid.io/suite-group/organization/1/run/?apiKey=<apiKey>'

В ответе вернется новый статус организации

{"isActive":true}