Skip to content

AdobeDocs/lightroom-public-apis

Repository files navigation

Lightroom Services

Adobe Photoshop Lightroom stores user assets, with their associated metadata and media renditions, in a catalog in the cloud.

Accessing Lightroom Content

Lightroom content of a Creative Cloud customer is managed through a set of RESTful APIs. These APIs are available only to entitled partner applications that have authenticated the customer, and the customer has given their express permission to the client to act on their behalf. The API Reference documents the available APIs.

Partners must register a new integration with Adobe to obtain a unique client identifier (API key) for their application. Partner applications authenticate Lightroom customers through the Adobe Identity Management System (IMS) using a standard OAuth 2.0 workflow. This process enables a client to obtain an access token that must be included along with the integration API Key in privileged requests to the Lightroom APIs.

Where to ask for help

The slack channel #adobeio-onsite-onboarding is our main point of contact for help. Feel free to join the channel and ask any questions.

How to develop

For local development, simply use :

$ yarn install
$ yarn dev

For the developer documentation, read the following sections on how to:

For more in-depth instructions.

How to test

  • To run the configured linters locally (requires Docker):

    yarn lint

    NOTE If you cannot use Docker, you can install the linters separately. In .github/super-linter.env, see which linters are enabled, and find the tools being used for linting in Supported Linters.

  • To check internal links locally

    yarn test:links
  • To build and preview locally:

    yarn start

How to deploy

For any team that wishes to deploy to the developer.adobe.com and developer-stage.adobe.com websites, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern developer.adobe.com/{product}/. This will allow doc developers to setup their subpaths to look something like:

developer.adobe.com/{product}/docs
developer.adobe.com/{product}/community
developer.adobe.com/{product}/community/code_of_conduct
developer.adobe.com/{product}/community/contribute

Launching a deploy

You can deploy using the GitHub actions deploy workflow see deploy instructions.