Opkey Apk Instrumentation Apis API

openapi: 3.2.0
info:
  title: pCloudy Device Cloud Apk Instrumentation Apis API
  version: v2
  summary: Public REST API for the pCloudy real-device cloud, an Opkey product.
  description: 'The pCloudy REST API is the machine-readable surface of the pCloudy real-device testing cloud operated by Opkey (Smart Software Testing Solutions Inc.). It covers authentication, device booking and session lifecycle, app upload/install/control, device interaction, performance capture, session media and logs, network simulation, APK instrumentation, app resigning, App Center integration, and Appium/XCTest automation orchestration. All methods default to POST except authentication, and requests set Content-Type: application/json.


    PROVENANCE: this document was generated by API Evangelist from the operations, parameters and examples published in Opkey''s own public pCloudy API Reference at https://content.pcloudy.com/apidocs/ . Opkey does not publish an OpenAPI document; every path, method, parameter and description here is transcribed from that published reference and nothing has been invented. It is a third-party transcription, not a provider artifact.'
  contact:
    name: Opkey
    url: https://www.opkey.com/
  x-generated-by: API Evangelist enrichment pipeline
  x-source: https://content.pcloudy.com/apidocs/
servers:
- url: https://{cloud}.pcloudy.com
  description: pCloudy cloud instance
  variables:
    cloud:
      default: device
      enum:
      - device
      - demo
      - aus
      description: pCloudy cloud host prefix; the docs refer to this as <Cloud URL>.
security:
- accessToken: []
tags:
- name: Apk Instrumentation Apis
paths:
  /api/instrument/initiate:
    post:
      operationId: instrumentInitiateLegacy
      summary: Instrument Initiate
      tags:
      - Apk Instrumentation Apis
      description: This API initiate the instrumentation process.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - filename
              - isImageInjection
              - isBiometricAuth
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                filename:
                  type: string
                  description: APK file which want to resign.
                isImageInjection:
                  type: string
                  description: Enable or Disable imagee injection instrumentation (true/false)
                isBiometricAuth:
                  type: string
                  description: Enable or Disable Biometric Authentication instrumentation (true/false)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
  /api/instrument/progress:
    post:
      operationId: instrumentationProgressLegacy
      summary: Instrumentation Progress
      tags:
      - Apk Instrumentation Apis
      description: This API is used to get the instrumentation status of the application .
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - instrumentation-token
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                instrumentation-token:
                  type: string
                  description: instrumentation Token (which will get from instrument initiate api)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
  /api/instrument/download:
    post:
      operationId: downloadInstrumented
      summary: Download Instrumented File
      tags:
      - Apk Instrumentation Apis
      description: This api download the instrumented application in myapp/data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - instrumentation-token
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                instrumentation-token:
                  type: string
                  description: instrumentation token (which will get from instrument initiate api)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with your pCloudy email as the username and your API access key as the password. Used only by GET /api/access to mint an access token.
    accessToken:
      type: apiKey
      in: header
      name: token
      description: Access token returned by GET /api/access. Newer /api/v2/* operations send it as a `token` header; several legacy /api/* operations send the same token as a `token` field in the JSON request body.
externalDocs:
  description: pCloudy API Reference
  url: https://content.pcloudy.com/apidocs/