📘 User Guide Template
- Document Purpose 🟢 No changes required in this section.
This guide provides business, functional and technical context to help API consumers understand and integrate the API. It complements the OpenAPI specification and is part of the mandatory documentation set for each version ( Major.Minor.Patch ).
- Target Audience 🟢 No changes required in this section.
Profile Role Product Owner Understand the business scope and value of the API Developer Implement and integrate the API QA / Architect Validate expected behaviors and technical compliance Customer Connect API (CCA) Support API consumers during onboarding and integration 3. API Overview 🔴 This section must be completed by the feature team.
3.1 Business Context – The API enables the application to retrieve and consume content specific to a given brand and language, based on the provided brandCode and locale. This allows front-end applications to dynamically render brand-specific experiences that are localized and aligned with the user’s selected language preferences.
Usage context : Brand details sheet page 3.2 Main Features List of supported operations Retrieve the breadcrumb object for a destination * 3.3 Known Limitations Functional constraints 4. Access & Security 🔴 This section must be completed by the feature team.
4.1 Access Requirements Requirement Provided by Accor Consumer Action Required Client ID / API Key ✅ 🔲 Request via onboarding 4.2 Authentication & Headers Auth method: API Key Required headers: apiKey 5. API Behavior 5.1 Traceability & Telemetry 5.2 Health Check 6. Endpoints 🔴 This section must be completed by the feature team.
/ecom/v1/brand-corner/brand-details (GET) Description Return the brandDetails object
Request Rules Mandatory: language , brandCode Response Behavior Returns 404 status code if no brand Details object is found for the given language and brand code 7. Usage Examples 🔴 This section must be completed by the feature team.
🔍 Get a brand Details GET /ecom/v1/brand-corner/brand-details?language=en&brandCode=twf { "heading": { "title": "25hours", "kicker": "Lifestyle by Ennismore", "description": "You know one, you know none", "image": "https://m.ahstatic.com/is/image/accorhotelsbuildqa/aja_p_6322-02?fmt=jpg&op_usm=1.75,0.3,2,0&resMode=sharp2&iccEmbed=true&icc=sRGB&dpr=on,1&wid=335&qlt=80" }, "highlight": { "title": "You know one, you know none", "subTitle": "Quirky & Elaborate", "description": "Each 25hours Hotel is individual and made-to-measure. Each one has a soul inspired by its location and is shaped by the art, culture, gastronomy and stories of its surroundings. Democratic and tolerant, catering for work and leisure, we welcome anyone with a sense of inquisitiveness and an adventurous spirit. We gladly open our world to those who open theirs. Founded in 2001, 25hours has 16 hotels including Berlin, Paris, Zurich, Vienna, Florence, and Copenhagen.", "image": "https://m.ahstatic.com/is/image/accorhotelsbuildqa/aja_p_6322-03?fmt=jpg&op_usm=1.75,0.3,2,0&resMode=sharp2&iccEmbed=true&icc=sRGB&dpr=on,1&wid=335&qlt=80" } } 8. Error Codes 🔴 This section must be completed by the feature team.
HTTP Code Error Code Description Recommended Action 400 INVALID_INPUT Invalid or missing fields Check input data 401 UNAUTHORIZED Invalid or expired token Refresh or re-authenticate 404 NOT_FOUND Entity does not exist Check resource ID 500 INTERNAL_ERROR Unexpected backend issue Retry or escalate