Applications

Install Application

Required scopes: application.installation (Read and Write).

Install an application either from a hosted manifest URL or from its manifest content.<br><br>Note: Any application - with or without a backend, and regardless of whether it is published to the Crowdin Store - can be installed from a manifest URL (the manifest only needs to be reachable at that URL). Installing from manifest content is supported only for serverless apps - apps that run entirely in the browser with no backend (no baseUrl).

post/applications/installations

Request

Request body

OR

Example request

{
  "url": "https://localhost.dev/crowdin.json",
  "permissions": {
    "user": {
      "value": "restricted",
      "ids": [
        1
      ]
    },
    "project": {
      "value": "restricted",
      "ids": [
        1
      ]
    }
  },
  "modules": [
    {
      "key": "some-module-key",
      "permissions": {
        "user": {
          "value": "restricted",
          "ids": [
            1
          ]
        }
      }
    }
  ],
  "manifestHash": "5536b952d54e0846b6fd69217f6eb7cfdcfba41774732926e1f0c1a158a6e405"
}

Response

Application Installation was successfully created

Example response

{
  "data": {
    "identifier": "example-application",
    "name": "Application name",
    "installedBy": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith"
    },
    "description": "Application description",
    "logo": "/resources/images/logo.png",
    "logoUrl": "https://localhost.dev/resources/images/logo.png",
    "agent": {
      "id": 12,
      "username": "john_smith",
      "fullName": "John Smith"
    },
    "baseUrl": "https://localhost.dev",
    "manifestUrl": "https://localhost.dev",
    "createdAt": "2019-09-20T11:34:40+00:00",
    "manifestUpdatedAt": "2019-09-20T11:34:40+00:00",
    "modules": [
      {
        "key": "example-application",
        "type": "module-type",
        "permissions": {
          "user": {
            "value": "restricted",
            "ids": [
              1
            ]
          }
        },
        "authenticationType": "none"
      }
    ],
    "scopes": [
      "project"
    ],
    "permissions": {
      "user": {
        "value": "restricted",
        "ids": [
          1
        ]
      },
      "project": {
        "value": "restricted",
        "ids": [
          1
        ]
      }
    },
    "defaultPermissions": {
      "user": "owner",
      "project": "own"
    },
    "limitReached": true,
    "bundle": {
      "mode": "internal"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.