Opkey App Center Api API

The App Center Api API from Opkey — 5 operation(s) for app center api.

OpenAPI Specification

opkey-app-center-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: pCloudy Device Cloud App Center Api 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: App Center Api
paths:
  /api/get_appcenter_apps:
    post:
      operationId: getAppCenterApps
      summary: Get App Center Apps
      tags:
      - App Center Api
      description: These APIs allow users to directly use the app that is present in the "Microsoft App Center" account and install it on the connected device on the pCloudy platform. This will save users the time that is required for uploading various apps.This used to fetch the app that is already there in the user account app center account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
  /api/get_appcenter_app_releases:
    post:
      operationId: appCenterReleases
      summary: Get App Center App Releases
      tags:
      - App Center Api
      description: This API is used to fetch all the builds of an application
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - appcenter_token
              - app_username
              - app_name
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                appcenter_token:
                  type: string
                  description: App Center Token(will get from Get App Center App API response)
                app_username:
                  type: string
                  description: App User Name (will get from Get App Center App API response)
                app_name:
                  type: string
                  description: Application Name (will get from Get App Center App API response)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
  /api/get_appcenter_app_release_details:
    post:
      operationId: appCenterReleaseDetails
      summary: Get App Center App Release Details
      tags:
      - App Center Api
      description: This API is used to retrieve release information of a specific app.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - appcenter_token
              - app_username
              - app_name
              - app_releaseid
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                appcenter_token:
                  type: string
                  description: App Center Token(will get from Get App Center App API response)
                app_username:
                  type: string
                  description: App User Name (will get from Get App Center App API response)
                app_name:
                  type: string
                  description: Application Name (will get from Get App Center App API response)
                app_releaseid:
                  type: string
                  description: Release Id ( will get from Get App Center App releases response(ie id))
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
  /api/upload_appcenter_app:
    post:
      operationId: downloadUploadAppCenter
      summary: Download or Upload the App Center Apps to pCloudy Portal
      tags:
      - App Center Api
      description: This is used to download or upload the app to the pCloudy platform from the App center
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - download_url
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                download_url:
                  type: string
                  description: APP Download url of app center(will get from Get App Center App release details response)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
  /api/delete_external_app:
    post:
      operationId: deleteAppCenterApp
      summary: Delete uploaded App Center App from pCloudy Portal
      tags:
      - App Center Api
      description: This API is used to delete the app center app from pcloudy platform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - token
              - filename
              properties:
                token:
                  type: string
                  description: Authtoken (this will get from authenticate response)
                filename:
                  type: string
                  description: App name to delete
      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/