راهنمای API پروفایل
در مقاله های قبل به معرفی و بررسی مستندات وب سرویس پروفایل پرداختیم در این مقاله قصد داریم به راهنمای وب سرویس پروفایل بپردازیم
یکی از برنامه‌هایی که پروفایل دنبال می‌کند ارائه بستری مناسب برای برنامه‌نویسان است تا بتوانند از داده‌های ثبت شده‌ی پروفایل در پروژه‌های خودشان استفاده کنند.
این مجموعه سرویس‌ها به کاربران کمک خواهند کرد تا مجبور به ثبت اطلاعات تکراری در سرویس‌های مختلف نباشند و در عین حال به برنامه‌نویسان کمک می‌کند تا با سرعت بیشتری سرویس‌های خود را توسعه دهند و در قسمت عمده‌ای از هزینه‌های تولید و نگهداری صرف جویی نمایند.
در راستای استفاده‌ی راحت برنامه‌نویسان، سعی داریم استفاده از این سیستم را به صورت مفصل مستند کنیم. هم‌زمان با رونمایی کامل سیستم برنامه‌نویسان، مستندات آن نیز برای شما عزیزان عرضه خواهد شد.
API اصلی سرویس آواتار پروفایل
API اصلی سرویس آواتار پروفایل به شما این امکان را خواهد داد که به تصاویر کاربران براساس آدرس ایمیل و همچنین شماره تماس آن‌ها دسترسی پیدا کنید. این API علاوه بر سرویس پروفایل و گراواتار با سرویس Google Plus و تلگرام نیز یکپارچه‌سازی شده‌است.
درصورتی که درخواست براساس شماره تماس فرد باشد، اولویت دریافت از سرویس پروفایل و اولویت بعد با سرویس تلگرام می‌باشد. در صورتی که درخواست براساس آدرس ایمیل فرد باشد اولویت اول دریافت از سرویس پروفایل، اولویت دوم سرویس گوگل و در نهایت سرویس گراواتار می باشد.
این اولیت‌بندی‌ها درجهت دریافت به‌روزترین تصاویر و اطلاعات کاربران می‌باشد.
https://avatar.profile.ir/get?type=email&v={email_address}
خروجی JSON
{
“entry”: {
“hash”: null,
“mobile”: null,
“email”: “sample@domain.com”,
“profileUrl”: null,
“username”: null,
“thumbnailUrl”: “https://files.profile.ir/Thumbs/sample/sample.jpg”,
“displayName”: “sample User”
}
}
https://avatar.profile.ir/get?type=mobile&v=+98{phone_number}
خروجی JSON
{
“entry”: {
“hash”: null,
“mobile”: +981234567890,
“email”: null,
“profileUrl”: http://profile.ir/sampleUser,
“username”: “sampleUser”,
“thumbnailUrl”: “https://files.profile.ir/Thumbs/sample/sample.jpg”,
“displayName”: “sample User”
}
}
لطفا در نظر داشته باشید شماره تماس تنها در قالب +98 قابل قبول است و همچنین در هنگام استفاده به جای استفاده از کاراکتر + از مقدار انکد شده‌ی آن (%2B) استفاده شود.
در صورتی که برای درخواست شما هیچ پاسخی یافت نشود JSON بامحتوای زیر دریافت خواهید کرد.
{“entry”:null}
امنیت اطلاعات
در جهت حفظ اطلاعات افراد به‌خصوص هنگام استفاده مستقیم از شماره تماس یا آدرس ایمیل آن‌ها، بهتر است که درخواست شما در سمت سرور اجرا شده و سپس خروجی در سمت کلاینت مورد استفاده قرار گیرد.
منبع