پرش به محتوای اصلی

API باز

API حسابداری طلا برای برنامه‌نویس‌ها

طلاکنش اولین برنامه‌ای است که وصل شده، نه آخرین؛ سایت فروشگاه، اپ، ربات یا نرم‌افزار دیگرتان هم از سرور خودش با یک کلید API به همین دفتر وصل می‌شود

API زرگیتی برای وصل کردن سایت و اپ فروشگاه طلا به دفتر حسابداری

یک درخواست، یک سند در دفتر

  • پولی خرید و فروش طلا و سکه: ثبت، خواندن و ابطال
  • دریافت و پرداخت، و حواله بین مشتری‌ها
  • مانده‌ی هر مشتری به تومان، گرم و سکه، و سندهایش برای ریز حساب
  • مستقیم در دفتر، یا پیش‌نویس تا فروشگاه خودش نگاه کند و ثبت کند
POST /api/v1/partner/tradesAuthorization: Bearer zgk_••••••••••••Content-Type: application/json{  "externalId": "tk-trade-1045",  "type": "sale",  "customer": {    "externalId": "tk-cust-88",    "name": "آقای رضایی"  },  "mazaneh": 101000000,  "lines": [    { "commodity": "gold", "weight": 5 }  ]}201 Created{ "status": "posted", "documentNumber": 12,  "totalAmount": 116579713 }
سند شماره‌ی 12 در دفتر فروشگاه ثبت شد، به نام آقای رضایی؛ همان که در طلاکُنش خرید

کلید جدا، تکرار بی‌خطر

  • کلید جدا برای هر برنامه؛ نحوه‌ی ثبت، مستقیم یا پیش‌نویس، با شماست
  • تکرار بی‌خطر: درخواستی که بی‌جواب ماند دوباره فرستاده می‌شود و دو بار ثبت نمی‌شود
  • کلید فقط از سرور برنامه پذیرفته می‌شود و زرگیتی فقط هش آن را نگه می‌دارد
  • سقف درخواست برای هر کلید، و نام کلید روی هر سندی که ثبت می‌کند
  • مستندات کامل داخل پنل، با فایل OpenAPI برای Postman
طلاکنش، اولین برنامه‌ی وصل‌شده
مستندات API زرگیتی داخل پنل، با فهرست مسیرها و فایل OpenAPI
مستندات API داخل پنل زرگیتی

پرسش‌های رایج

با API زرگیتی چه کارهایی می‌شود کرد؟

پولی خرید و فروش ثبت کرد، خواند و باطل کرد؛ دریافت و پرداخت و حواله ثبت کرد؛ و مانده و ریز سندهای هر مشتری را خواند

اگر درخواستی بی‌جواب بماند و دوباره بفرستم، دو بار ثبت می‌شود؟

نه، هر معامله با شناسه‌ی خود برنامه‌ی شما ثبت می‌شود و درخواست تکراری همان نتیجه‌ی قبلی را برمی‌گرداند

مستندات API کجاست؟

داخل پنل خود زرگیتی، در تنظیمات، با فایل OpenAPI که در Postman باز می‌شود؛ پس از ساخت فروشگاه در دسترس شماست

کلید API را می‌شود از اپ موبایل صدا زد؟

نه، کلید فقط از سرور برنامه پذیرفته می‌شود، نه از صفحه‌ی وب یا اپ گوشی؛ اپ شما به سرور خودتان می‌گوید و سرور به زرگیتی

فروشگاهتان را در زرگیتی بسازید

کلید API را پس از ساخت فروشگاه، در تنظیمات زرگیتی می‌سازید؛ مستندات هم همان‌جاست