AppSkyline Batch API

openapi: 3.2.0
info:
  title: Appskyline Com Batch API
  version: 1.0.0
  x-api-versioning:
    currentVersion: '1'
    requestHeader: API-Version
    responseHeader: API-Version
    compatibilityPolicy: Omitting API-Version selects version 1. Unsupported versions return HTTP 400 with supportedVersions.
    deprecationPolicy: AppSkyline announces incompatible versions at least 180 days before removal. Deprecated responses include Deprecation, Sunset, and a Link relation named deprecation.
    deprecationHeaders:
    - Deprecation
    - Sunset
    - Link
    policyUrl: https://www.appskyline.com/api.md#compatibility-version
  description: 'Operations tagged Batch across 2 of this provider''s published API definitions: appskyline-api.swagger.json, appskyline-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.appskyline.com
tags:
- name: Batch
paths:
  /api/batch:
    post:
      tags:
      - Batch
      summary: Read multiple collections in one request
      description: Executes an array of authenticated read operations and returns an object keyed by each operation alias. Only the allowlisted app, keyword, preference, role and metadata collections can be read.
      security:
      - accessToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                type: object
                required:
                - alias
                - url
                properties:
                  alias:
                    type: string
                  url:
                    type: string
                    description: Allowed collection plus optional query string
      responses:
        '200':
          description: Results keyed by operation alias
        '401':
          description: Missing or invalid credentials
        '403':
          description: A requested collection is not batch-readable
      operationId: postApiBatch
      x-codeSamples:
      - lang: Node + Request
        source: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'https://api.appskyline.com/api/batch',\n  headers: {'content-type': 'application/json', Authorization: 'REPLACE_KEY_VALUE'},\n  body: [{alias: 'string', url: 'string'}],\n  json: true\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - lang: Shell + Curl
        source: "curl --request POST \\\n  --url https://api.appskyline.com/api/batch \\\n  --header 'Authorization: REPLACE_KEY_VALUE' \\\n  --header 'content-type: application/json' \\\n  --data '[{\"alias\":\"string\",\"url\":\"string\"}]'"
      - lang: Shell + Httpie
        source: "echo '[{\"alias\":\"string\",\"url\":\"string\"}]' |  \\\n  http POST https://api.appskyline.com/api/batch \\\n  Authorization:REPLACE_KEY_VALUE \\\n  content-type:application/json"
      - lang: Python + Python3
        source: "import http.client\n\nconn = http.client.HTTPSConnection(\"api.appskyline.com\")\n\npayload = \"[{\\\"alias\\\":\\\"string\\\",\\\"url\\\":\\\"string\\\"}]\"\n\nheaders = {\n    'content-type': \"application/json\",\n    'Authorization': \"REPLACE_KEY_VALUE\"\n    }\n\nconn.request(\"POST\", \"/api/batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"
      - lang: Php + Curl
        source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_URL => \"https://api.appskyline.com/api/batch\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => \"\",\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 30,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => \"POST\",\n  CURLOPT_POSTFIELDS => \"[{\\\"alias\\\":\\\"string\\\",\\\"url\\\":\\\"string\\\"}]\",\n  CURLOPT_HTTPHEADER => [\n    \"Authorization: REPLACE_KEY_VALUE\",\n    \"content-type: application/json\"\n  ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n  echo \"cURL Error #:\" . $err;\n} else {\n  echo $response;\n}"
      - lang: Php + Http1
        source: "<?php\n\n$request = new HttpRequest();\n$request->setUrl('https://api.appskyline.com/api/batch');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n  'content-type' => 'application/json',\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$request->setBody('[{\"alias\":\"string\",\"url\":\"string\"}]');\n\ntry {\n  $response = $request->send();\n\n  echo $response->getBody();\n} catch (HttpException $ex) {\n  echo $ex;\n}"
      - lang: Php + Http2
        source: "<?php\n\n$client = new http\\Client;\n$request = new http\\Client\\Request;\n\n$body = new http\\Message\\Body;\n$body->append('[{\"alias\":\"string\",\"url\":\"string\"}]');\n\n$request->setRequestUrl('https://api.appskyline.com/api/batch');\n$request->setRequestMethod('POST');\n$request->setBody($body);\n\n$request->setHeaders([\n  'content-type' => 'application/json',\n  'Authorization' => 'REPLACE_KEY_VALUE'\n]);\n\n$client->enqueue($request)->send();\n$response = $client->getResponse();\n\necho $response->getBody();"
    servers:
    - url: https://api.appskyline.com
components:
  headers:
    Deprecation:
      description: Present only when this API operation or version is deprecated. The value is an RFC 9745 Structured Field Date.
      schema:
        type: string
        example: '@1893456000'
    DeprecationLink:
      description: Present on deprecated responses and points to the applicable migration or deprecation policy with rel="deprecation".
      schema:
        type: string
        example: <https://www.appskyline.com/api.md#compatibility-version>; rel="deprecation"
    Sunset:
      description: Present on deprecated responses when a retirement date is scheduled. The value is an HTTP-date.
      schema:
        type: string
        example: Tue, 01 Jan 2030 00:00:00 GMT
  schemas:
    Error:
      type: object
      description: Structured JSON API error.
      required:
      - name
      - message
      - status
      properties:
        name:
          type: string
        message:
          type: string
        status:
          type: integer
        details:
          type: object
          additionalProperties: true
    BatchResponse:
      type: object
      description: Map from each requested alias to its result array.
      additionalProperties:
        type: array
        items:
          type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: 'HTTP Basic auth carrying only the API key secret: `Authorization: Basic base64(<key secret>)`.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Operator session token issued by the Appskyline dashboard: `Authorization: Token <access token>`.'
x-refined-from:
- appskyline-api.swagger.json
- appskyline-com-openapi.json