از امروز، API والگلد در اختیار توسعهدهندگان، کسبوکارها و تیمهای فنی قرار گرفته است. با استفاده از این API میتوانید محصولات و ابزارهای خود را به زیرساخت معاملاتی والگلد متصل کنید، اطلاعات بازار طلا را دریافت کنید و فرایندهای خرید و فروش را بهصورت یکپارچه در سیستم خود انجام دهید.
برای سادهتر شدن مسیر توسعه و پیادهسازی، مستندات کامل API والگلد به زبان فارسی و انگلیسی منتشر شده است. در این مستندات، ساختار درخواستها و پاسخها، پارامترهای موردنیاز، نمونه کد، خطاهای احتمالی و روش اتصال امن به سرویسها بهصورت مرحلهبهمرحله توضیح داده شدهاند.
چه امکاناتی در دسترس است؟
نسخهٔ فعلی API والگلد سرویسهای اصلی موردنیاز برای اتصال به بازار طلا را پوشش میدهد:
- دریافت اطلاعات بازار، نماد معاملاتی، محدودیتهای سفارش، وضعیت خرید و فروش، ضرایب کارمزد و آمار ۲۴ ساعت گذشته
- مشاهده موجودی طلا و تومان
- دریافت قیمت معتبر برای ثبت سفارش خرید یا فروش، با اعتبار ۳۰ ثانیهای
- ثبت سفارش خرید و فروش طلا
- دریافت جزئیات و وضعیت سفارش با استفاده از شناسه سفارش
تمام درخواستها و پاسخها با ساختار JSON مبادله میشوند. سرویسهای خصوصی با API Key در دسترس هستند و این کلید بهصورت Authorization: Bearer YOUR_SECRET_TOKEN در هدر درخواست ارسال میشود.
توضیحات بیشتر را در خصوص ارسال درخواست و ساخت کلید Api را در این لینک میتوانید دسترسی داشته باشید
مستندات فارسی و ابزارهای موردنیاز توسعهدهندگان
در مستندات جدید تلاش کردهایم مسیر اتصال به API تا حد ممکن روشن و قابل پیشبینی باشد. برای هر سرویس میتوانید متد و آدرس درخواست، پارامترها، نمونه پاسخ موفق، خطاهای رایج و توضیح فیلدهای Response Body را مشاهده کنید.
نمونه کد آماده برای ۱۲ زبان و محیط برنامهنویسی در دسترس است: Node.js، JavaScript، Python، PHP، Go، Java، Kotlin، C#، C، Ruby، Rust و Shell. برای هر زبان هم میتوانید کتابخانهٔ موردنظرتان را انتخاب کنید؛ مثلاً Axios، Fetch یا undici برای Node.js و Requests، HTTPX یا aiohttp برای Python. همچنین امکان آزمایش مستقیم درخواستها مهیا شده هست و میتوانید فایل سواگر را از این لینک دریافت کنید
نکته: تمامی ارورهایی که ممکنه باهاش مواجه بشید در داکیومنت موجود هست و با کلیک کردن روی هر فیلدکه زیرش خط کشیده شده، میتوانید توضیحات آن بخش بروید.
نکتهٔ مهم دربارهٔ قیمتگذاری سفارش
پیش از ثبت هر سفارش، ابتدا باید قیمت را از سرویس «دریافت قیمت جهت ثبت سفارش» بگیرید. سه نکته را در نظر داشته باشید:
- قیمت دریافتی تنها ۳۰ ثانیه اعتبار دارد و فراخوانی دوباره، این مدت را تمدید نمیکند.
- قیمت باید برای همان سمت معامله دریافت شود؛ برای سفارش خرید، قیمت خرید و برای سفارش فروش، قیمت فروش.
- اگر اعتبار قیمت به پایان برسد، ثبت سفارش با خطای INVALID_PRICE برگردانده میشود.
اتصال امن با API Key
برای استفاده از سرویسهای خصوصی، در اپلیکیشن والگلد از بخش «مدیریت API» یک کلید جدید بسازید. هنگام ساخت کلید میتوانید نامی برای آن انتخاب کنید، IPهای مجاز را مشخص کنید و مدت اعتبار ۳۰، ۶۰ یا ۹۰ روزه را تعیین کنید. ساخت کلید با کد یکبارمصرف پیامکی تأیید میشود.
API Key فقط یکبار نمایش داده میشود؛ بنابراین لازم است پیش از بستن صفحه آن را کپی کنید، در محیطی امن نگه دارید و از قرار دادن آن در کدهای عمومی یا اشتراکگذاری با دیگران خودداری کنید. محدود کردن IPهای مجاز نیز امنیت کلید را بهطور محسوسی بالا میبرد. راهنمای تصویری و مرحلهبهمرحلهٔ ساخت کلید در صفحهٔ ساخت API Key قرار دارد.
برای شروع آمادهاید؟
اگر در حال توسعه یک ابزار معاملاتی، داشبورد مالی، سامانه سازمانی یا محصولی مبتنی بر بازار طلا هستید، API والگلد مسیر اتصال مستقیم به خدمات ما را برای شما فراهم میکند.
برای مشاهده راهنمای شروع، نمونه درخواستها و جزئیات همه سرویسها، همین حالا به مستندات فارسی API والگلد مراجعه کنید.
این آغاز مسیر توسعه API والگلد است. با گسترش سرویسها و دریافت بازخورد توسعهدهندگان، قابلیتهای بیشتری به این مجموعه اضافه خواهد شد.
