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

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

آدرس سرویس: POST /https://api.cloudcarbon.ir/carbon/v4.0/aaa/get_token


شرح

این سرویس جهت دریافت توکن برای استفاده از سرویس های سامانه ابری کربن مورد استفاده قرار می گیرد.


Headers

مقادیر زیر باید در هدر قرار بگیرد

  Authorization : Basic ....
  clientAddress : ip client

توضیحات

  • Authorization:برای استفاده از سرویس های سامانه ابری کربن نیاز به توکن هست و برای دریافت دریافت توکن می بایست نام کاربری و رمز عبور دریافت شده را به روش Basic Authentication این سرویس ارسال نمایید. برای ساخت توکن Basic Authentication باید رشته username : password را Base64 درست کنید .
  • clientAddress: آی پی سروری که سرویس را فراخوانی کرده است

نمونه درخواست:

curl --location --request POST 'https://api.cloudcarbon.ir/carbon/v4.0/aaa/get_token' \
--header 'Content-Type: application/json' \
--header 'clientAddress: xxx' \
--header 'Authorization: ••••••'

جواب موفق:

{
    "status": "0",
    "message": "تراکنش با موفقیت انجام شد",
    "timestamp": "2025-12-07 12:16:00.325",
    "tracking_number": "20251207121559770",
    "request_number": "20251207121559770",
    "result": {
        "token": "......",
        "token_type": "Bearer",
        "client_id": ".....",
        "expire_date": "تاریخ انقضا توکن",
        "scope": "....."
    },
    "transaction_details": {},
    "errors": {}
}

جواب ناموفق:

{
    "status": "1",
    "message": "تراکنش ناموفق",
    "timestamp": "2025-12-09 12:31:45.641",
    "tracking_number": "20251209123144958",
    "request_number": "20251209123144958",
    "result": {},
    "transaction_detials": {},
    "errors": {
        "error_code": "4000",
        "error_description": "Access is denied Authentication Failed",
        "reference_name": "invalid client_id",
        "original_value": "No permission service"
    }
}
  • status: عدد 0 به معنی موفق و عدد 1 به معنی ناموفق می باشد
  • message: پاسخ از طرف سرویس سامانه ابری کربن
  • request number: شماره پیگیری ارسال شده در زمان فراخوانی
  • tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
  • result: آبجکتی از پاسخ سرویس شامل:
  • token: توکن داده شده
  • token_type: مدل توکن
  • client_id: یوزر کلاینت که سرویس را فراخوانی کرده است
  • expire_date: تاریخ انقضا توکن
  • scope: سطح دسترسی کلاینت به سرویس ها
  • در صورت بروز خطا در درخواست :

  • tracking_number: شماره پیگیری ایجاد شده توسط سامانه ابری کربن جهت بررسی های بعدی
  • errors: جزییات خطا
  • error_code: کد مربوط به خطایی که پیش آمده است
  • error_description: متن خطا
  • reference_name: اطلاعات تکمیلی خطا
  • original_value: اطلاعات تکمیلی خطا