add: post_semantic_create documentation (#116)

* add: post_semantic_create documentation * Update README.md --------- Co-authored-by: Mobin Pourabedini <[email protected]> Co-authored-by: Saeed Alipoor <[email protected]>
divar-ir · Jan 11, 2025 · c237d2a · c237d2a
1 parent 54119cf
commit c237d2a
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 6 deletions.
diff --git a/ReadMe.md b/ReadMe.md
@@ -328,8 +328,8 @@ POST https://api.divar.ir/oauth2/token
 [راهنما » افزونه‌های کاربر » حذف]: ./addons/user-addons.md#حذف-افزونه-کاربر
 
 [راهنما » اطلاعات معنایی کاربر]: ./semantic
-[راهنما » اطلاعات معنایی کاربر » درج]: ./semantic/create.md
-[راهنما » اطلاعات معنایی کاربر » حذف]: ./semantic/delete.md
+[راهنما » اطلاعات معنایی کاربر » درج]: ./semantic/user_semantic_create
+[راهنما » اطلاعات معنایی کاربر » حذف]: ./semantic/user_semantic_delete
 
 [راهنما » تیکت پرداخت]: ./payment-ticket
 [راهنما » تیکت پرداخت » بررسی صحت]: ./payment-ticket/validate.md

diff --git a/semantic/README.md b/semantic/README.md
@@ -3,11 +3,15 @@
 
 # اطلاعات معنایی کاربر
 
-در برخی شرایط نیاز است بدون ساخت افزونه ، اطلاعاتی درباره کاربر به دیوار فرستاده شود.
+در برخی شرایط نیاز است بدون درج افزونه، اطلاعاتی درباره کاربر در دیوار ذخیره شود.
 
 > نام کاربری در دیوار، همان شماره موبایل است
 
-برای این منظور از `API` های اطلاعات معنایی کاربر استفاده کنید. در این سرویس مانند افزونه قابلیت ارسال اطلاعات معنایی و تیکت پرداخت( به صورت اختیاری ) وجود دارد.
+برای این منظور از `API` های اطلاعات معنایی کاربر استفاده کنید. در این سرویس مانند افزونه قابلیت ارسال اطلاعات معنایی و تیکت پرداخت(اختیاری) وجود دارد.
 
-- [ساخت](create.md)
-- [پاک کردن](delete.md)
+- [ساخت](user_semantic_create)
+- [پاک کردن](user_semantic_delete)
+
+# اطلاعات معنایی آگهی
+در برخی شرایط نیاز است بدون درج افزونه، اطلاعاتی درباره آگهی در دیوار ذخیره شود.
+- [ساخت](post_semantic_create)
diff --git a/semantic/post_semantic_create.md b/semantic/post_semantic_create.md
@@ -0,0 +1,28 @@
+# ساخت و به روز رسانی
+
+| Upsert Post Semantic |                      |
+|----------------------|----------------------|
+| API Permissions      | POST_SEMANTIC_CREATE |
+| OAuth Permissions    | POST_SEMANTIC_CREATE |
+| Rate Limit           | Unlimited            |
+
+### ویژگی‌ها
+با استفاده از این اندپوینت می‌توانید اطلاعات معنایی یک آگهی را ایجاد یا به روز رسانی کنید.
+اطلاعات معنایی می‌تواند اطلاعاتی مانند نتیجه احراز هویت، اطلاعات مربوط به محتوای آگهی و ... باشد.
+توجه داشته باشید که این اطلاعات برای کاربران دیوار قابل مشاهده نیست و تنها برای استفاده‌ی دیوار در پردازش‌های داخلی مورد استفاده قرار می‌گیرد.
+
+## ریکوئست
+
+```http request
+POST https://api.divar.ir/experimental/open-platform/semantic/post/{{post_token}}
+x-access-token: {{access-token}}
+x-api-key: {{api-key}}
+
+{
+
+    "semantic": {
+        "some-key": "some value to be hashed",
+        "identity_verification_result": "FACE_AND_ID_MATCHED"
+    },
+}
+```
diff --git a/semantic/create.md → semantic/user_semantic_create.md b/semantic/create.md → semantic/user_semantic_create.md
diff --git a/semantic/delete.md → semantic/user_semantic_delete.md b/semantic/delete.md → semantic/user_semantic_delete.md