Add semantics

ReadMe.md

@@ -17,15 +17,15 @@
 - با ارائه‌ی خدمات در چت، تعامل کاربرها را در راستای معامله‌ی سریع‌تر و مطمئن‌تر تسهیل کنید.
 ---
 
-🚀 برای شروع کار در **کنار دیوار**، [در لیست انتظار ثبت‌نام کنید][فرم ثبت‌نام] تا دسترسی شما به [پنل کنار دیوار][پنل کنار] را فراهم کنیم. 
+🚀 برای شروع کار در **کنار دیوار**، [در لیست انتظار ثبت‌نام کنید][فرم ثبت‌نام] تا دسترسی شما به [پنل کنار دیوار][پنل کنار] را فراهم کنیم.
 
 ---
 
 <br>
 
 > 🚧 ***در دست احداث*** 🚧
->  
-> **کنار دیوار**‌ در حال حاضر در مرحله‌ی آزمایشی است و امکان ثبت‌نام عمومی در آن وجود ندارد. برای ثبت‌نام و فعالیت در این بستر، [در لیست انتظار ثبت‌نام کنید][فرم ثبت‌نام]. در این مرحله ممکن است قواعد، سیاست‌ها و ابزارهای **کنار دیوار** دچار تغییرات ناگهانی شوند. به دلیل سرعت تغییرات، ممکن است در بازه‌های زمانی خاصی اطلاعات ارائه شده در این مخزن نیز ناقص یا نیازمند بروزرسانی باشند. 
+>
+> **کنار دیوار**‌ در حال حاضر در مرحله‌ی آزمایشی است و امکان ثبت‌نام عمومی در آن وجود ندارد. برای ثبت‌نام و فعالیت در این بستر، [در لیست انتظار ثبت‌نام کنید][فرم ثبت‌نام]. در این مرحله ممکن است قواعد، سیاست‌ها و ابزارهای **کنار دیوار** دچار تغییرات ناگهانی شوند. به دلیل سرعت تغییرات، ممکن است در بازه‌های زمانی خاصی اطلاعات ارائه شده در این مخزن نیز ناقص یا نیازمند بروزرسانی باشند.
 
 <br>
 
@@ -76,7 +76,7 @@
 ۳. در این مرحله شما می‌توانید [اطلاعات آگهی][راهنما » اطلاعات آگهی] یا [اطلاعات کاربر][راهنما » اطلاعات کاربر] را ([با اجازه‌ی کاربر][راهنما » احراز باز]) از دیوار بگیرید. \
 ۴. به علاوه، در این مرحله می‌توانید [با اجازه‌ی کاربر][راهنما » احراز باز]، در مکالمه‌ [پیام ارسال کنید][راهنما » افزونه‌های چت » ارسال پیام]. \
 ۵. بعد از پایان تعامل، اپلیکیشن باید کاربر را [به دیوار برگرداند][راهنما » مدیریت اپ »‌ تعامل در چت]. \
-۶. شما می‌توانید به پیام‌های ارسالی در مکالمه، دکمه‌هایی برای طرفین مکالمه ضمیمه کنید که کاربرها با استفاده از آن‌ها، [با برنامه‌ی شما تعامل نمایند][راهنما » افزونه‌های چت » ارسال پیام‌ » دکمه]. دقت کنید که حتما بعد از پایان تعامل با کاربر، وی را [به دیوار بازگردانید][راهنما » مدیریت اپ »‌ تعامل در چت]. 
+۶. شما می‌توانید به پیام‌های ارسالی در مکالمه، دکمه‌هایی برای طرفین مکالمه ضمیمه کنید که کاربرها با استفاده از آن‌ها، [با برنامه‌ی شما تعامل نمایند][راهنما » افزونه‌های چت » ارسال پیام‌ » دکمه]. دقت کنید که حتما بعد از پایان تعامل با کاربر، وی را [به دیوار بازگردانید][راهنما » مدیریت اپ »‌ تعامل در چت].
 
 <br>
 
@@ -86,7 +86,7 @@
 <br>
 
 > 💡 ***مثال*** \
->  برنامه‌ی تنظیم قرارداد به کاربر پیشنهاد می‌شود. وی از طریق برنامه نمونه‌ی قرارداد دلخواه را انتخاب کرده، اطلاعات مربوط به خویش را وارد کرده و به شکل دیجیتال امضاء می‌نماید. برنامه لینک مربوط به این قرارداد را به همراه پیامی در مکالمه برای طرف دیگر ارسال می‌کند، کاربر دیگر با باز کردن لینک مشخص شده قرارداد را پر نموده و به صورت دیجیتال امضاء می‌نماید، سپس برنامه نسخه‌ی امضاء شده را برای طرفین در مکالمه ارسال می‌کند. 
+>  برنامه‌ی تنظیم قرارداد به کاربر پیشنهاد می‌شود. وی از طریق برنامه نمونه‌ی قرارداد دلخواه را انتخاب کرده، اطلاعات مربوط به خویش را وارد کرده و به شکل دیجیتال امضاء می‌نماید. برنامه لینک مربوط به این قرارداد را به همراه پیامی در مکالمه برای طرف دیگر ارسال می‌کند، کاربر دیگر با باز کردن لینک مشخص شده قرارداد را پر نموده و به صورت دیجیتال امضاء می‌نماید، سپس برنامه نسخه‌ی امضاء شده را برای طرفین در مکالمه ارسال می‌کند.
 
 <br>
 
@@ -163,6 +163,7 @@
 [راهنما » اطلاعات کاربر]: ./oauth/get_user.md
 [راهنما » احراز باز]: ./oauth
 [راهنما » افزونه‌های آگهی]: ./addons
+[راهنما » افزونه‌های کاربر]: ./user-addons
 [راهنما » افزونه‌های آگهی » ساخت]: ./addons/approved_addon.md
 [راهنما » افزونه‌های آگهی » حذف]: ./addons/delete.md
 [راهنما » افزونه‌های آگهی » معنی]: ./addons/semantic.md

user-addons/README.md

@@ -15,3 +15,4 @@
 با این حال، افزونه کاربر با تنظیمات مناسب میتواند منجر به الصاق افزونه آگهی روی آگهی‌های گذشته با عمق ۳۰ آگهی و آگهی‌های آینده تا زمان وجود افزونه گردد.
 
 - [افزونه کاربر](user-addons.md)
+- [اطلاعات معنایی](semantic.md)

user-addons/semantic.md

@@ -0,0 +1,20 @@
+# اطلاعات معنایی
+
+اطلاعات معنایی افزونه کاربر میتواند هر آبجکت مسطح با کلیدها و مقادیر دلخواه هر دو از جنس رشته حروف باشد؛ با اینحال، برخی کلیدها و مقادیر در برای دیوار معنای خاصی حمل میکنند. در ادامه این موارد را بررسی میکنیم.
+
+> انتظار میرود اطلاعات معنایی شامل تمام مواردی که در ذیل آن افزونه تولید شده است باشد. از جمله عناوینی که برای تولید ویجت‌ها به کار برده شده‌اند.
+
+## مقادیر معنایی در دیوار
+
+| Key         | Example Value | Description        |
+| ----------- | ------------- | ------------------ |
+| national_id | 0023456789    | کد ملی             |
+| full_name   | رضا حسنی      | نام و نام خانوادگی |
+| birth_date  | 1370-04-31    |                    |
+
+> ممکن است شما بخواهید مقادیر دیگری را بصورت معنایی در افزونه ذخیره‌سازی کنید. این مقادیر در صورت کاربردی بودن برای دیوار در جدول بالا اضافه میشوند.
+
+## مقادیر حساس
+
+برای مشخص نمودن مقادیر حساس سمنتیک، لازم است این کلید‌ها را در مقدار `semantic_sensitives` پر نمایید.
+پیش از ذخیره‌سازی مقادیر سمنتیک در دیتابیس، تضمین میشود که مقادیر این کلیدها به روش امن و برگشت‌ناپذیری (`bcrypt`) هش میشوند و فقط هش آنها ذخیره‌سازی میگردد.

user-addons/user-addons.md

@@ -11,8 +11,7 @@
 ## ریکوئست
 
 ```http request
-POST https://api.divar.ir/v1/open-platform/addons/user/verification
-X-Debug-Token: {{debug-token}}
+POST https://api.divar.ir/v1/open-platform/addons/user/{{phone}}
 x-access-token: {{access-token}}
 x-api-key: {{api-key}}
 
@@ -45,15 +44,16 @@ x-api-key: {{api-key}}
     },
     "notes": "test note",
     "phone": "09991234567",
-    "categories": ["light"],
+    "categories": [],
     "management_permalink": "https://same-domain.com/manage/id",
     "ticket_uuid": "812d56e6-e44d-45e7-8932-f9acbd416999",
     "verification_cost": 124000,
     "semantic": {
-        "phone": "09991234567",
+        "national_id": "0023456789",
         "full_name": "علی علوی",
         "external_reference": "ref-id"
-    }
+    },
+    "semantic_sensitives": ["national_id"]
 }
 ```
 
@@ -66,11 +66,11 @@ x-api-key: {{api-key}}
 | management_permalink | string   | "https://same-domain.com/manage/id"    | لینک مدیریت افزونه کاربر که از صفحه «دیوار من» قابل دسترسی خواهد بود. این صفحه باید با OAuth محافظت شود |
 | ticket_uuid          | string   | "812d56e6-e44d-45e7-8932-f9acbd416999" | مشاهده [بلیط پرداخت](../payment-ticket)                                                                 |
 | verification_cost    | int32    | 124000                                 | هزینه انجام خدمت به ریال                                                                                |
-| semantic             | object   | {}                                     | TBD                                                                                                     |
-
+| semantic             | object   | {}                                     | [اطلاعات معنایی](semantic.md)                                                                           |
 
 > - داشتن اکسس توکن با درسترسی مربوطه برای الصاق این نوع افزونه الزامی است
-> - برای الصاق افزونه‌آگهی روی همه دسته‌ها، کافیست لیست دسته‌بندی‌ها را خالی بگذارید. در صورتی که بخواهید روی هیچ دسته‌بندی‌ای افزونه آگهی الصاق نشود، لازم است لیست ویجت‌ها خالی باشد
+> - برای الصاق افزونه‌آگهی روی همه دسته‌ها، کافیست لیست دسته‌بندی‌ها را خالی بگذارید.
+> - در صورتی که بخواهید روی هیچ دسته‌بندی‌ای افزونه آگهی الصاق نشود، لازم است لیست ویجت‌ها خالی باشد
 
 ## ریسپانس