API docs
میاد path اینجا
فرم کلی هرچی تو این صفحه میبینید این شکلیه:
این چیزیه که باید بفرستید:
send:
body:{ attr1 , attr2 , ... }
header: nothing
param: nothing
تو بخش body شما باید یه json بفرستید که
فیلد هایی که مشخص
شده رو داشته باشه و
اگر نداشته باشه یا درست نباشه ارور برمیگرده و با توجه به ارور میتونید درستش کنید
تو header هم همین طور
در مورد param هم اگه لازم بود به اخر url یه
اسلش میزنید
و مقدار رو میزارید بعد اسلش
در صورت اینکه با کلمه های nothing مواجه شدید مثل همین مثال بالا ینی لازم نیست در مورد
اونا
کاری بکنید و همون دیفالت رو بفرستید
همه ی ریکویست ها هم با متد post کار میکنه
جا هایی هم که offset دیدید ینی کل دیتا رو یه جا نمیتونید بگیرید و باید چند تا چند تا
بگیرید در اولین ریکويست offset رو مساوی 1 قرار بدید و هر بار یدونه بهش اضافه کنید
هر جا به مشکلی خوردید هم با من در تماس باشید
در مورد url
در مورد url ی که باید بهش ریکويست بفرستید عبارت path رو اخر هاستنیم قرار بدید
مثلا وقتی path برار account/login باشه url میشه
http://hostname/account/login
در مورد param هم باید به انتهای url اضافه بشه
مثلا شما از مسیر account/getAccountInfo میتونید اطلاعات حساب یه شخص رو با username اون
شخص بگیرید که با فرض اینکه username اون شخص ali77gh باشه اینطوری میشه :
http://hostname/account/getAccountInfo/ali77gh
/account/signup
توضیحات:
با ریکویست فرستادن به این مسیر شما میتونید یه اکانت بسازید و حتما هم لازم نیست که ایمیل
خودتون رو بزنید چون نیاز به تایید نداره
send:
body:{ email , username , password , fullName , bio }
header: nothing
param: nothing
/account/login
توضیحات:
این یکی هم برای لاگین کردن هست و در صورت درست بودن username و پسورد در جواب یه توکن
بهتون
میده که باید توی ریکويست های بعدی بزاریدش تو header تا هویت شما در سمت سرور مشخص شه
send:
body:{ username , password }
header: nothing
param: nothing
از اینجا به بعد در این داکیومنت هر وقت x-auth-token رو دیدید به جای مقدارش باید توکنی
که از
لاگین گرفتید رو بزارید
لازمه بگم که این توکن فقط ۲۴ ساعت قابل استفاده هست و بعد از اون دوباره باید لاگین کنید
و از
توکن جدید توی ریکویست هاتون استفاده کنید
/account/getAccountInfo
توضیحات:
میتونید اطلاعات یه اکانت رو بگیرید
send:
body: nothing
header: nothing
param: { username }
/account/editFullName
توضیحات:
از اسمش مشخصه
send:
body:{ newFullName }
header: { x-auth-token }
param: nothing
/account/editBio
توضیحات:
از اسمش مشخصه
send:
body:{ newBio }
header: { x-auth-token }
param: nothing
/account/editPassword
توضیحات:
از اسمش مشخصه
send:
body:{ oldpassword , newpassword }
header: { x-auth-token }
param: nothing
/account/logout
توضیحات:
توکنی که میفرستید رو میزاره تو black list و دیگه با اون توکن نمیشه کاری کرد
send:
body: nothing
header: { x-auth-token }
param: nothing
/account/searchbyusername
توضیحات:
username های شبیه رو میاره
send:
body:{ username , offset }
header: nothing
param: nothing
برای offset به
راهنما
مراجعه کنید
/account/follow
توضیحات:
یا این میتونید یه نفر رو فالو کنید
send:
body:{ username }
header: nothing
param: nothing
/account/unfollow
توضیحات:
با این میتونید یکی رو انفالو کنید
send:
body:{ username }
header: nothing
param: nothing
/account/getfollowers
توضیحات:
لیست follwer های یه نفر رو میده
send:
body:{ username }
header: nothing
param: nothing
/account/getfollowings
توضیحات:
لیست follwing های یه نفر رو میده
send:
body:{ username }
header: nothing
param: nothing
/account/countfollowers
توضیحات:
follower های یه نفر رو میشماره
send:
body:{ username }
header: nothing
param: nothing
/account/countfollowings
توضیحات:
following های یه نفر رو میشماره
send:
body:{ username }
header: nothing
param: nothing
/post/newPost
توضیحات:
حالا یه پست بزاریم
send:
body:{ title , content }
header: { x-auth-token }
param: nothing
/post/editTitle
توضیحات:
از اسمش معلومه
send:
body:{ id , newTitle }
header: { x-auth-token }
param: nothing
اینجا id منظور ای دی پست هست
/post/editContent
توضیحات:
از اسمش معلومه
send:
body:{ id , newContent }
header: { x-auth-token }
param: nothing
اینجا id منظور ای دی پست هست
/post/editContent
توضیحات:
از اسمش معلومه
send:
body:{ id , newContent }
header: { x-auth-token }
param: nothing
اینجا id منظور ای دی پست هست
/post/getPost
توضیحات:
از اسمش معلومه
send:
body: nothing
header: nothing
param: posttId
اینجا id منظور ای دی پست هست
/post/deletePost
توضیحات:
از اسمش معلومه
send:
body: { postId }
header: nothing
param: posttId
/post/getSomeonesPosts
توضیحات:
از اسمش معلومه
send:
body: { username , offset }
header: nothing
param: nothing
برای offset به
راهنما
مراجعه کنید
/post/countSomeonesPosts
توضیحات:
از اسمش معلومه
send:
body: { username }
header: nothing
param: nothing
/post/getMyWallWithOffset
توضیحات:
از اسمش معلومه
send:
body: { offset }
header: {x-auth-token}
param: nothing
/hashtag/getPostHashtags
توضیحات:
هشتگ های یه پست رو میگیره
send:
body: { postId }
header: nothing
param: nothing
/hashtag/getHashtagPostsWithOffset
توضیحات:
پست های یه هشتگ رو میگیره
send:
body: { hashtagName , offset }
header: nothing
param: nothing
برای offset به
راهنما
مراجعه کنید
/hashtag/countHashtagPosts
توضیحات:
پست های یه هشتگ رو میشماره
send:
body: { hashtagName }
header: nothing
param: nothing
/hashtag/searchHashtagByName
توضیحات:
هشتگ های شبیه به چیزی که میفرستید رو بر میگردونه
send:
body: { hashtagName }
header: nothing
param: nothing
/like/newLike
توضیحات:
یه پست رو لایک میکنه
send:
body: { postId }
header: { x-auth-token }
param: nothing
/like/deleteLike
توضیحات:
لایک یه پستی رو پس میگیره
send:
body: { postId }
header: { x-auth-token }
param: nothing
/like/getLikesByPostOffset
توضیحات:
کسایی که یه پست رو لایک کردن رو بر میگردونه
send:
body: { postId , offset }
header: nothing
param: nothing
برای offset به
راهنما
مراجعه کنید
/like/countLikesByPost
توضیحات:
لایک های یه پست رو میشمره
send:
body: { postId }
header: nothing
param: nothing