Metadata
Generate SEO Friendly Metadata to your given route about your given term that can be used in your solution website:
Endpoint
Description
- Method:
POST - Origin:
https://seo.lwe.ai/api - Route:
/google/getORgenerateSEOMetadata - Accept:
application/json - Auth:
API_KEY
Body
{
"route": "<path of your page route you want to generate metdata for>",
"term": "<description of your page content>", // string or array
"lang": "<target language>",
"country": "<target country>",
"solution": "<your solution name>"
}
How to use?
- JavaScript
- Python
- cURL
- axios request
- npm package
First, Install axios if not already installed:
npm i axios
Second, Call /getORgenerateSEOMetadata endpoint:
// import axios
import axios from "axios"
// request body
const body = {
route: "/players/salah",
term: "mohamed salah liverpool player",
lang: "ar",
country: "EG",
solution: "liverpool"
}
// add your API_KEY in headers
const config = {
headers: {
API_KEY: "YOUR_API_KEY"
}
}
// call axios request
axios.post("https://seo.lwe.ai/api/google/getORgenerateSEOMetadata", body, config).then(res=> {
console.log(res.data) // process response data
}).catch(err => {
console.error(err.message)
})
First, Install our package metadata-wrapper:
npm i metadata-wrapper
Second, import and use module method directly:
// import metadata-wrapper
import metadataWrapper from "metadata-wrapper"
// sample html
const html = "<html><head></head><body></body></html>";
// meta body
const metaBody = {
route: "/test",
term: "test",
lang: "en",
country: "EG",
solution: "test"
}
// you need to pass your API_KEY as well
const apiKey = "YOUR_API_KEY"
// call metadataWrapper method directly
metadataWrapper(html, metaBody, apiKey).then(updatedHtml => {
console.dir(updatedHtml)
}).catch(err => {
console.error("Error generating metadata:", error.message)
})
Note: This package is recommended for serverside rendering.
First, Install requests if not already installed:
pip install requests
Second, Call /getORgenerateSEOMetadata endpoint:
# import requests
import requests
# request body
body = {
"route": "/players/salah",
"term": "mohamed salah liverpool player",
"lang": "ar",
"country": "EG",
"solution": "liverpool"
}
# add your API_KEY in headers
headers = {
"API_KEY": "YOUR_API_KEY"
}
# call request
try:
res = requests.post("https://seo.lwe.ai/api/google/getORgenerateSEOMetadata", json=body, headers=headers)
res.raise_for_status() # Check for HTTP errors
print(res.json()) # Process the JSON response
except requests.exceptions.RequestException as err:
print(f"An error occurred: {err}")
curl -X POST https://seo.lwe.ai/api/google/getORgenerateSEOMetadata \
-H "Content-Type: application/json" \
-H "API_KEY: YOUR_API_KEY" \
-d "{ \"route\": \"/players/salah\", \"term\": \"mohamed salah liverpool player\", \"lang\": \"ar\", \"country\": \"EG\", \"solution\": \"liverpool\"}"
One line command cURL request:
curl -X POST https://seo.lwe.ai/api/google/getORgenerateSEOMetadata -H "Content-Type: application/json" -H "API_KEY: YOUR_API_KEY" -d "{ \"route\": \"/players/salah\", \"term\": \"mohamed salah liverpool player\", \"lang\": \"ar\", \"country\": \"EG\", \"solution\": \"liverpool\"}"
Sample Reponse Data
{
solution: "liverpool",
route: "/players/salah",
title: "محمد صلاح: الملك المصري في ليفربول",
description: "محمد صلاح، المعروف بالملك المصري، هو لاعب كرة قدم بارز في نادي ليفربول. تألق صلاح في الدوري الإنجليزي الممتاز منذ انضمامه إلى الفريق في عام 2017. سجل العديد من الأهداف الحاسمة وأصبح رمزًا للنجاح في ليفربول.",
keywords: [
"محمد صلاح لاعب ليفربول",
"11 محمد صلاح",
"الملك المصري مو صلاح",
"هدف صلاح",
"مو صلاح 2019",
"محمد صلاح 2018",
"محمد صلاح 2021",
"محمد صلاح 2022",
"محمد صلاح الإنجليزي",
"محمد صلاح باريس سان جيرمان"
],
_id: "67597cdb76ab08a6b2ce83b2",
createdAt: "2024-12-11T11:51:55.328Z",
updatedAt: "2024-12-11T11:51:55.328Z",
__v: 0
}
React Use Case
- Assume you have an article page that is talking about Solar Energy.
- It seems your page reach is low, and page is being ignored by search engines!
- To increase your page reach, you need to update it's metadata with trending and viral Solar Energy material.
Live Editor
function SolarEnergyArticle () { const [metadata, setMetadata] = useState({}) useEffect(() => { // get or generate seo metadata axios.post("https://seo.lwe.ai/api/google/getORgenerateSEOMetadata", { route: "/solar-energy", term: "solar energy", lang: "ar", country: "EG", solution: "my-articles" }, { headers: { API_KEY: "YOUR_API_KEY" } }).then(res => { setMetadata(res.data) }).catch((err) => { console.error(err.message) }) }, []) return ( <html lang="ar" dir="rtl"> <head> <title>{metadata?.title}</title> <meta name="keywords" content={metadata?.keywords?.join(', ')} /> <meta name="description" content={metadata?.description} /> </head> <body> <h1>استغل قوة الطاقة الشمسية: اكتشف أفضل حلول الطاقة الشمسية، والابتكارات الشمسية الصديقة للبيئة، وتقنية مصابيح LED الشمسية</h1> <p> الطاقة الشمسية هي مصدر قوي ومستدام للطاقة يزداد شعبيته في جميع أنحاء العالم. مع نمو الطلب على مصادر الطاقة النظيفة والمتجددة، تبرز الطاقة الشمسية كحل رائد. يتيح استخدام الألواح الشمسية، أو "الواح الطاقة الشمسية"، تحويل ضوء الشمس إلى كهرباء بكفاءة، مما يجعلها خيارًا صديقًا للبيئة لكل من التطبيقات السكنية والتجارية. مع التقدم في التكنولوجيا، أصبحت إضاءة LED الشمسية و"كاميرات مراقبة الطاقة الشمسية" (كاميرات المراقبة التي تعمل بالطاقة الشمسية) متاحة على نطاق واسع الآن، مما يوفر حلولاً موفرة للطاقة لمختلف الاحتياجات. شركات مثل "ميجا سولار" و"روزن سولار" في طليعة هذه الصناعة، حيث تقدم منتجات وخدمات مبتكرة. </p> {/* you also can utilize metadata keywords as hashtags*/} {metadata?.keywords?.map((word, idx)=><a key={idx}>#{word.replace(' ', '_')} </a>)} </body> </html> ) }
Result
Loading...