خدمات و API

آواتارمی برای برنامه نویسان و توسعه دهندگان در محیط وب از طریق رابط کاربردی برنامه نویسی امکان استفاده از نرم افزار آوتارساز را به عنوان بخشی از برنامه آنها ارائه می دهد. در صورتی که توسعه دهنده بازی یا نرم افزار هستنید به سادگی و با استفاده از چند خط کد می توانید به کاربرانتان امکان ساختن آواتار دلخواهشان و نمایش در نرم افزار و یا بازی شما را بدهید.

تولید و ارائه
آواتارها را به ما بسپارید

پس از ثبت نام و دریافت اشتراک خدمات آواتارمی به شما از طریق داشبورد سایت امکان ثبت وب سایت و یا نرم افزار خود را دارید. پس از ثبت هر نرم افزار کد Token منحصر به فردی مخصوص سایت ثبت شده تولید شده و به شما ارائه می گردد که شما می بایست از این Token برای دسترسی به آواتارساز استفاده کنید.

تصویر 1 - داشبورد API

تصویر 2 - افزودن سایت

تصویر 3 - دریافت Token

روشهای برقراری ارتباط نرم افزار یا بازی شما و آواتارمی به شیوه های زیر صورت می گیرد:

• فراخوانی آواتارساز توسط کاربران شما از نرم افزار شما: توسعه دهنده برای افزودن امکان ثبت تصویر کارتونی یا آواتار به کاربران می بایست توسط پیوند مشخصی کاربران را به صفحه آواتار ساز هدایت کند.

https://www.avatarz.top/generator?rt=[avatarMeToken]&ut=[playerToken]&avatar=[avatarCode]&theme=[themeCode]
    

avatarMeToken: در این قسمت از آدرس شما می بایست Token را که مطابق تصویر 3 از این سایت دریافت کرده اید را وارد کنید.

playerToken: هر کاربر در نرم افزار شما می بایست ID و یا Token منحصر به فرد خود را داشته باشد. برای اینکه پس از بازگشت کاربر از آواتارساز به نرم افزار شما بتوانید صحت هماهنگی کار بازگشت داده شده و کاربر سایت خود را مطمئن بشوید، هر مقداری که برای ما ارسال کنید، آواتارساز در هنگام بازگشت کاربر به سایت شما ارسال می کند.

avatarCode: این مقدار کد آواتار کاربر است که در سایت شما ذخیره شده است. در صورتی که هنوز کدی برای آواتار کاربر خود ذخیره نکرده اید این مقدار را خالی بگذارید.

themeCode: در صورتی که مایل هستید ظاهر آواتارساز به نرم افزار یا بازی شما شباهت بیشتری داشته باشد، می توانید نوع Theme آواتارساز را برای نمایش به کاربرانتان انتخاب کنید. در صورتی که نرم افزار شما از Theme های مختلفی مانند حالت شب و روز استفاده می کند، می توانید کاربران را بسته به Theme انتخاب شده در نرم افزار یا بازی شما به آواتارساز هدایت کنید. خالی بودن این مقدار باعث نمایش آواتار ساز با theme پیشفرض می گردد.
مقادیر انواع Themeها: dark, light

<a href="https://www.avatarz.top/generator?rt=[avatarMeToken]&ut=[playerToken]&avatar=[avatarCode]">
Edit Avatar
</a>
    

window.location = 'https://www.avatarz.top/generator?rt=[avatarMeToken]&ut=[playerToken]&avatar=[avatarCode]';
    

• بازگشت کاربر از آواتارساز به نرم افزار شما: کاربر پس از انجام تغییرات در آواتار خود با فشردن دکمه ذخیره توسط به آدرس بازگشت ثبت شده در داشتبورد مطابق تصویر 2 بازگشت داده می شود.
  آواتارساز به همراه آدرس بازگشت ثبت شده مقادیر کد آواتار انتخابی کاربر را به صورت QueryString به سایت شما باز می گرداند.

برای مثال سایت یا بازی شما در دامنه http://sample.com/ قرار دارد.
آدرس بازگشت که در داشبورد برای سایت خود ثبت کردید http://sample.com/save_avatar/ است.
آدرسی که شما کاربر را به سمت آواتارساز هدایت می کنید http://sample.com/generator?rt=XXXX&ut=player01 است.
آدرسی که کاربر از آواتارساز به سایت شما بازگردانده می شود http://sample.com/save_avatar/?ut=player01&avatar=00010100030502 خواهد بود.

شما باید در صفحه بازگشت کاربر را در صورتی که وارد سیستم شما شده شناسایی کنید، برای امنیت عملیات playerToken ارسالی خود را که آوتارساز به شما باز میگرداند با کاربری که در سایت شناسایی کردید تطبیق دهید و در صورت تایید صحت کد منحصر به فرد این کاربر مقدار avatar ارسال شده در QueryString را برای کاربر در پایگاه داده ذخیره کنید.

توجه داشته باشید که تنها نیاز به ذخیره این کد برای کاربر در نرم افزار خود دارد و آواتارساز هیچ داده ای از کاربر شما مانند playerToken و یا حتی کد avatar را ذخیره نمیکند و ذخیره این مقدار به عهده شما است.

تعداد دفعاتی که کاربران آواتارساز را برای ساختن تصویر مورد نظر خود استفاده میکنند و تعداد تصاویری که می سازند رایگان بوده و در درخواست های سایت شما ثبت نمی شود.

• نمایش آواتار کاربر در نرم افزار شما: برای نمایش آواتاری که کاربر برای خود ساخته در وب سایت یا بازی خود می بایست آدرس تصویر را مطابق الگوی زیر به همراه کد آواتار کاربر که در سایت خود ذخیره کرده اید وارد کنید:

https://www.avatarz.top/avatars/[avatarCode]
    

avatarCode: کد ذخیره شده در سایت شما در هنگام فرایند بازگشت کاربر از آواتارساز به سایت یا نرم افزار شما.

<img src="https://www.avatarz.top/avatars/[avatarCode]">
    

این درخواست‌ها توسط URL ارجاع درخواست تأیید می‌شوند. اما شما همچنین می توانید درخواست خود را با اضافه کردن token خود در هدر درخواست تأیید کنید:

token: [YOUR_VALIDATION_TOKEN]
    

تعداد درخواست هایی که از طرف سایت شما محاسبه می شوند تعداد درخواست ها برای نمایش تصویر آواتار کاربران در وب سایت شما است. با استفاده از این سیستم حجم بار و فضای مصرفی پهنای باند و دیسک توسط تصاویر آواتارهای کاربران به عهده سرورهای ما خواهد بود.

گزارش کارکرد روزانه API

شما می توانید به تفکیک میزان درخواستهای هر یک از پروژه های بازی یا نرم افزاری خود را در صفحه گزارش در داشبورد این سایت مشاهده کنید.

تصویر 4 - صفحه گزارش

اگر هنور اشتراک ندارید می توانید از دریافت اشتراک خدمات آواتارمی شروع کنید و از همین امروز بازی و نرم افزار خود را دارای قابلیت نمایش آواتار برای تصویر کاربری کنید. اگر هنوز نیاز به شواهد بیشتری برای تصمیم گیری و استفاده از آواتارساز ما در نرم افزار خود دارید با ما تماس بگیرید و درخواست دمو کنید.