Skip to main content

Header Endpoint

This guide explains how to interact with the Header endpoint in the Sumaya369 web application. The endpoint provides data for the website header, including social media links, pages, and banner information.

Get Header Data

Retrieve all header data for the website.

Endpoint

  • Method: GET
  • URL: /v1/customer/home-header

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenNo

Success Response

{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"header": {
"website_description": "<p>Example Website Description.</p>",
"sumaya_snapchat": "sumayah369",
"sumaya_twitter": "sumayah369",
"sumaya_instagram": "dr.sumayah369",
"sumaya_youtube": "DrSumaya369",
"sumaya_tiktok": "dr.sumaya369",
"sumaya_podcast": "id1440015781?l=ar",
"pages": [
{
"title": "الوظائف",
"key": "jobs",
"priority": 1,
"logged_in_only": false
}
],
"banner": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/23525/image127.png"
}
},
"status_code": 200
}

Implementation Notes

  • Returns website description, social media links, and navigation pages
  • Pages are filtered to exclude specific system pages
  • Pages are ordered by priority
  • Banner image URL is included if a background banner exists
  • No caching is implemented for this endpoint