Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rainforest QA clients API

Operations about clients

Rainforest QA clients API is one of 18 APIs that Rainforest QA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include clients. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 4 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://app.rainforestqa.com/api.

4 operations 3 paths 10 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://app.rainforestqa.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rainforest QA clients API declares 1 security scheme for authenticating requests. An API key is passed in the header as CLIENT_TOKEN (api_key). By default, every request must be authenticated.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

clients 4

Operations about clients

GET
/1/clients
Fetch your account details
get-clients → 200
PUT
/1/clients
Update account information
put-clients body → 200400
GET
/1/clients/stats
Fetch usage stats
get-client-stats → 200
POST
/1/clients/select
Select different client
post-clients-select body → 201400401

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Client (25 properties), put-clients (10 properties), Environment (10 properties), BrowserWithDefault (9 properties). Each schema is shown below with its type and property counts.

Environment
object
Environment model
10 properties 6 required
put-clients
object
Update account information
10 properties
BrowserWithDefault
object
9 properties
Error
object
Error model
1 property 1 required
RunProgress
object
7 properties
Client
object
Client model
25 properties
BrowserCreditCost
object
4 properties
RunLite
object
9 properties
post-clients-select
object
Select different client
1 property 1 required
SiteEnvironment
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainforest-qa-clients-api-openapi.yml Raw ↑

Other APIs Rainforest QA publishes across the network.

Rainforest QA callback API
Rainforest QA connections API
Rainforest QA credit_cards API
Rainforest QA environments API
Rainforest QA features API
Rainforest QA folders API
Rainforest QA generators API
Rainforest QA on_premise_crowd API
Rainforest QA run_groups API
Rainforest QA runs API
Rainforest QA site_environments API
Rainforest QA sites API