iOS · JSON Structure

Ios Server Apis Structure

Compact structural map of every server-side API surface Apple exposes for iOS developers.

Type: object Properties: 3
iOSAppleMobileApp StorePush NotificationsIn-App PurchasesSubscriptionsAuthenticationWalletDeveloper Platform

Ios Server Apis Structure is a JSON Structure definition published by iOS, describing 3 properties. It conforms to the https://json-structure.org/structure meta-schema.

Properties

platform vendor apis

Meta-schema: https://json-structure.org/structure

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/structure",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ios/main/json-structure/ios-server-apis-structure.json",
  "title": "iOS Server-Side API Surface",
  "description": "Compact structural map of every server-side API surface Apple exposes for iOS developers.",
  "type": "object",
  "properties": {
    "platform": { "type": "string", "const": "iOS" },
    "vendor": { "type": "string", "const": "Apple" },
    "apis": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["id", "name", "baseURL", "auth"],
        "properties": {
          "id": { "type": "string" },
          "name": { "type": "string" },
          "baseURL": { "type": "string", "format": "uri" },
          "sandboxURL": { "type": "string", "format": "uri" },
          "auth": {
            "type": "string",
            "enum": ["jwt-es256", "client-secret-jwt", "jwt-or-mtls", "developer-token+user-token", "webhook-jws"]
          },
          "transport": {
            "type": "string",
            "enum": ["rest-json", "rest-jsonapi", "http2-push", "webhook"]
          },
          "openapi": { "type": "string", "format": "uri" },
          "asyncapi": { "type": "string", "format": "uri" }
        }
      }
    }
  }
}