8000 GitHub - Ramhm/nerkh-lab: Testing and experimentation environment for NERKH web service · GitHub
[go: up one dir, main page]

Skip to content
7FFF
RamhmPublic

About

Testing and experimentation environment for NERKH web service

Resources

Stars

5 stars

Watchers

1 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

Repository files navigation

🪙 Nerkh API Examples

نمونه‌کدهای کوتاه و آماده برای اتصال به Nerkh API و دریافت قیمت طلا، ارز و رمزارز از نسخه ۲.

✨ این ریپو برای چیست؟

  • 🚀 شروع سریع کار با Nerkh API
  • 🧩 الگو گرفتن برای پروژه‌های واقعی
  • 🌍 اجرا و تست روی لینوکس، ویندوز و مک
  • 📚 نمونه‌کد در زبان‌ها و فریم‌ورک‌های مختلف

🔗 مشخصات API

مورد مقدار
Base URL https://api.nerkh.io
Endpoint GET /v2/prices/json/all
احراز هویت Authorization: Bearer YOUR_TOKEN
مستندات کامل openapi.yaml

پاسخ شامل گروه‌های gold، currency و crypto است و برای هر آیتم قیمت فعلی، تغییر ۲۴ ساعته، محدوده قیمت و زمان به‌روزرسانی را برمی‌گرداند.

📁 ساختار ریپو

🖥️ بک‌اند

دایرکتوری زبان توضیح
🐍 python/ Python دریافت و چاپ همه قیمت‌ها با کتابخانه استاندارد
💎 ruby/ Ruby دریافت و چاپ قیمت‌ها با net/http
🟢 nodejs/ Node.js + Express سرور واسط برای نگه‌داشتن توکن سمت سرور
☕ java/ Java نمونه Maven با HttpClient
🐘 php/ PHP نمونه CLI با cURL
🟣 dotnet/ .NET کنسول C# با System.Text.Json
🐹 go/ Go نمونه CLI با net/http
🦀 rust/ Rust نمونه CLI با reqwest
➕ cpp/ C++ نمونه CMake با libcurl و nlohmann/json
🧙 delphi/ Delphi کنسول با System.Net.HttpClient

🎨 فرانت‌اند

دایرکتوری فناوری توضیح
🌐 html/ HTML + JavaScript صفحه ساده بدون build
🔷 typescript/ TypeScript + Vite نسخه تایپ‌شده نمونه HTML
⚛️ react/ React + Vite نمایش کارت‌های قیمت
💚 vue/ Vue + Vite نمایش کارت‌های قیمت
🔥 svelte/ Svelte + Vite نمایش کارت‌های قیمت

🧪 راهنمای تست API

دایرکتوری سیستم‌عامل توضیح
🐧 linux/ Linux تست با curl و jq در Shell
🪟 windows/ Windows تست با PowerShell و curl.exe
🍎 macos/ macOS تست با curl و jq در Terminal

⚡ شروع سریع

export NERKH_API_TOKEN="YOUR_TOKEN_HERE"

curl -sS -H "Authorization: Bearer $NERKH_API_TOKEN" \
  "https://api.nerkh.io/v2/prices/json/all"

🔑 تنظیم توکن

  • توکن را در بالای کد هر نمونه، در API_TOKEN قرار دهید.
  • در نمونه‌های خط فرمان می‌توانید از متغیر محیطی NERKH_API_TOKEN استفاده کنید.
  • ❗ هیچ‌وقت توکن واقعی را در ریپو commit نکنید.

⚠️ نکته امنیتی فرانت‌اند

نمونه‌های فرانت‌اند توکن را در مرورگر استفاده می‌کنند و فقط برای یادگیری مناسب‌اند. در پروژه واقعی از یک بک‌اند واسط مثل نمونه nodejs/ استفاده کنید تا توکن افشا نشود.

🚨 خطاهای رایج

کد معنی
401 توکن اشتباه یا نامعتبر است
403 توکن غیرفعال (deactivated) شده است
460 تعداد درخواست‌ها بیش از حد مجاز است (QuotaExceeded)
404 مسیر یا نسخه API اشتباه است
500 خطای داخلی سرور؛ دوباره تلاش کنید

📖 راهنمای هر نمونه

هر دایرکتوری یک فایل help.md دارد که شامل پیش‌نیازها، تنظیم توکن و دستور اجرا برای لینوکس، ویندوز و مک است.

Website / Documentation

🌐 Official Website: https://nerkh.io

📚 Official Documentation: https://docs.nerkh.io

About

Testing and experimentation environment for NERKH web service

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

0