User Guide: DAM Search Typology API

1. Document Purpose

This guide provides business, functional and technical context to help API consumers understand and integrate the API. It complements the OpenAPI specification (specs/openapi.yaml) and is part of the mandatory documentation set for each version (Major.Minor.Patch).

2. Target Audience

3. API Overview

3.1 Business Context

The API retrieves, for a specific brand, the assets stored in the Accor Digital Asset Management (AEM DAM) that belong to a given typology (category). It lets front-end applications and partners get the right visual content (for example, all the assets of a typology for a brand) without browsing the DAM directly.

3.2 Main Features

• Retrieve the assets of a brand for a given typology.
• Each asset is returned with its public path, name, format and lastUpdate.

3.3 Known Limitations

• Read-only: only GET is supported (any other method returns 405).
• Both brand and typologie query parameters are mandatory.
• Unknown query parameters are rejected by the gateway.

4. Access & Security

4.1 Access Requirements

4.2 Authentication & Headers

• Auth method: API Key
• Required header: apikey

4.3 Environments

5. API Behavior

5.1 Traceability & Telemetry

Every call is traced by the API gateway. When contacting support, provide the date and time of the call, the request URL (without the API key) and the HTTP status code received.

5.2 Health Check

No dedicated health endpoint is exposed. A GET /ecom/v1/assets/typology call with valid brand and typologie values returning 200 confirms that the API and your API key are working.

6. Endpoints

GET /ecom/v1/assets/typology

Description: Returns, for a brand, all the available assets of the requested typology in the AEM DAM.

Request rules: both parameters are required.

Response behavior

• 200: returns an objects array of assets and, when more results exist, a nextPageToken.
• 404: the brand or the typology does not exist.

Asset object

7. Usage Examples

🔍 Retrieve the assets of a typology for a brand

curl -G "https://api.accor.com/ecom/v1/assets/typology" \
  -H "apikey: <YOUR_API_KEY>" \
  --data-urlencode "brand=<BRAND_CODE>" \
  --data-urlencode "typologie=<TYPOLOGY>"

Response (abridged):

{
  "objects": [
    {
      "path": "https://m.ahstatic.com/is/generic/accorhotelsbuildqa/full-monochrome-29",
      "name": "full-monochrome.svg",
      "format": "image/svg+xml",
      "lastUpdate": "2023-10-23T15:21:34.465Z"
    }
  ]
}

8. Error Codes

Error responses are JSON objects with the fields title, status and code.