پروفایل ها



متد ها :

POST /profiles ایجاد پروفایل جدید

ایجاد پروفایل

ایجاد پروفایل جدید .

POST /profiles

محتوی درخواست (Body parameters)

name نوع:String عنوان:نام کسب و کار نام کسب و کار و یا فروشنده در فاکتر ها و پیام های ارسالی از طریق ایمیل و پیامک نمایش داده می شود .
description نوع:String عنوان:توضیحات توضیحات یک تغریف کوتاه از کسب و کار و یا شرکت است .
tel نوع:Integer عنوان:تلفن شماره تماس با فروشنده یک رشته عددی است که بروی فاکتورها درج می شود .
email نوع:String عنوان:ایمیل آدرس ایمیل فروشنده بروی فاکتور و در ایمیل ها نمایش داده می شود .
address نوع:String عنوان:آدرس آدرس شرکت بروی فاکتور نمایش داده می شود .
site نوع:String عنوان:وب سایت آدرس وب سایت کسب و کار بروی فاکتور نمایش داده می شود .
slug نوع:String عنوان:کد فروشگاه کد فروشگاه یک نام کاربری دلخواه است که فقط شامل حروف و اعداد انگلیسی می شود . از این کد در سرویس های سفارش پیامکی و تلگرام و ... استفاده می شود .
telegram نوع:String عنوان:آدرس تلگرام آدرس تلگرام بروی فاکتور ها نمایش داده می شود .
facebook نوع:String عنوان:آدرس فیسبوک آدرس صفحه فیسبوک بروی فاکتور ها نمایش داده می شود .
instagram نوع:String عنوان:آدرس اینستاگرام آدرس صفحه اینستاگرام بروی فاکتور ها نمایش داده می شود .
twitter نوع:String عنوان:آدرس توییتر آدرس صفحه توییتر بروی فاکتور ها نمایش داده می شود .

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

                        curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"name":"حسابان", "email":"[email protected]", "tel":02188624168, "address":"تهران ، میرداماد ، کوچه رازان ، پلاک ۷"}' "https://api.hesabit.com/v1/profiles/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 201 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": {
        "Profile": {
            "id": "50151ea8-1540-429b-8a68-49ef2e65e143",
            "name": "هاستینگ",
            "description": "سرویس های میزبانی ابری",
            "slug": "hosting",
            "address": "تهران ، میرداماد ، کوچه رازان ، پلاک ۷",
            "tel": "02188624168",
            "email": "[email protected]",
            "site": "http://www.sample.com",
            "telegram": "http://telegram.me/sample",
            "facebook": "https://www.facebook.com/sample",
            "instagram": "http://instagram.com/sample",
            "twitter": "https://twitter.com/sample",
            "logo": "https://cdn.hesabit.com/profiles/logo/11/243/small.png",
            "signature": "https://cdn.hesabit.com/profiles/signature/11/243/small.png",
            "default": 1,
            "created": 1460952000
        }
    },
    "success": true,
    "status": 201
}
GET /profiles خواندن لیست پروفایل ها
GET /profiles/{profile id} خواندن یک پروفایل از طریق شناسه پروفایل

خواندن پروفایل ها

GET /profiles

گرفتن لیست پروفایل ها .


پارامترهای درخواست (Query parameters)

email نوع:String عنوان:ایمیل آدرس ایمیل فروشنده بروی فاکتور و در ایمیل ها نمایش داده می شود .
tel نوع:Integer عنوان:تلفن شماره تماس با فروشنده یک رشته عددی است که بروی فاکتورها درج می شود .
site نوع:String عنوان:وب سایت آدرس وب سایت کسب و کار بروی فاکتور نمایش داده می شود .
slug نوع:String عنوان:کد فروشگاه کد فروشگاه یک نام کاربری دلخواه است که فقط شامل حروف و اعداد انگلیسی می شود . از این کد در سرویس های سفارش پیامکی و تلگرام و ... استفاده می شود .
limit نوع:Integer عنوان:تعداد به صورت پیش فرض ۱۰ پروفایل آخر بازگردانده می شود . این مقدار تا ۱۰۰ رکورد قابل تنظیم است .
offset نوع:Integer عنوان:نقطه شروع نقطه شروع یک مقدار عددی است که نقطه شروع رکورد ها را در کوئری مشخص می کند .
page نوع:Integer عنوان:صفحه صفحه یک مقدار عددی است که برای صفحه بندی در کوئری استفاده می شود .

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

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/profiles/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48&limit=10"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Profile": {
            "id": "50151ea8-1540-429b-8a68-49ef2e65e143",
            "name": "هاستینگ",
            "description": "سرویس های میزبانی ابری",
            "slug": "hosting",
            "address": "تهران ، میرداماد ، کوچه رازان ، پلاک ۷",
            "tel": "02188624168",
            "email": "[email protected]",
            "site": "http://sample.com",
            "telegram": "http://telegram.me/sample",
            "facebook": "https://www.facebook.com/sample",
            "instagram": "http://instagram.com/sample",
            "twitter": "https://twitter.com/sample",
            "logo": "https://cdn.hesabit.com/profiles/logo/11/243/small.png",
            "signature": "https://cdn.hesabit.com/profiles/signature/11/243/small.png",
            "default": 1,
            "created": 1460952000
        }
    ],
    "success": true,
    "status": 200
}

خواندن یک پروفایل

GET /profiles/{profile_id}

خواندن یک پروفایل از طریق شناسه پروفایل .


مقادیر درخواست در آدرس (Path parameters)

profile_id شناسه پروفایل یک رشته ۳۶ کاراکتری منحصر به فرد است .

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

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/profiles/57151ea8-1540-429b-8a68-49ef2e65ec43?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Profile": {
                "id": "50151ea8-1540-429b-8a68-49ef2e65e143",
                "name": "هاستینگ",
                "description": "سرویس های میزبانی ابری",
                "slug": "hosting",
                "address": "تهران ، میرداماد ، کوچه رازان ، پلاک ۷",
                "tel": "02188624168",
                "email": "[email protected]",
                "site": "http://sample.com",
                "telegram": "http://telegram.me/sample",
                "facebook": "https://www.facebook.com/sample",
                "instagram": "http://instagram.com/sample",
                "twitter": "https://twitter.com/sample",
                "logo": "https://cdn.hesabit.com/profiles/logo/11/243/small.png",
                "signature": "https://cdn.hesabit.com/profiles/signature/11/243/small.png",
                "default": 1,
                "created": 1460952000
            }
        }
    ],
    "success": true,
    "status": 200
}
PUT /profiles/{profile_id} ویرایش یک پروفایل

ویرایش پروفایل

ویرایش یک پروفایل .

PUT /profiles/{profile_id}

محتوی درخواست (Body parameters)

name نوع:String عنوان:نام کسب و کار نام کسب و کار و یا فروشنده در فاکتر ها و پیام های ارسالی از طریق ایمیل و پیامک نمایش داده می شود .
description نوع:String عنوان:توضیحات توضیحات یک تغریف کوتاه از کسب و کار و یا شرکت است .
tel نوع:Integer عنوان:تلفن شماره تماس با فروشنده یک رشته عددی است که بروی فاکتورها درج می شود .
email نوع:String عنوان:ایمیل آدرس ایمیل فروشنده بروی فاکتور و در ایمیل ها نمایش داده می شود .
address نوع:String عنوان:آدرس آدرس شرکت بروی فاکتور نمایش داده می شود .
site نوع:String عنوان:وب سایت آدرس وب سایت کسب و کار بروی فاکتور نمایش داده می شود .
slug نوع:String عنوان:کد فروشگاه کد فروشگاه یک نام کاربری دلخواه است که فقط شامل حروف و اعداد انگلیسی می شود . از این کد در سرویس های سفارش پیامکی و تلگرام و ... استفاده می شود .
telegram نوع:String عنوان:آدرس تلگرام آدرس تلگرام بروی فاکتور ها نمایش داده می شود .
facebook نوع:String عنوان:آدرس فیسبوک آدرس صفحه فیسبوک بروی فاکتور ها نمایش داده می شود .
instagram نوع:String عنوان:آدرس اینستاگرام آدرس صفحه اینستاگرام بروی فاکتور ها نمایش داده می شود .
twitter نوع:String عنوان:آدرس توییتر آدرس صفحه توییتر بروی فاکتور ها نمایش داده می شود .

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

                        curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"email":"[email protected]", "telegram": "https://instagram.com/instagram"}' "https://api.hesabit.com/v1/profiles/50151ea8-1540-429b-8a68-49ef2e65e143?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": {
        "Profile": {
            "id": "50151ea8-1540-429b-8a68-49ef2e65e143",
            "name": "هاستینگ",
            "description": "سرویس های میزبانی ابری",
            "slug": "hosting",
            "address": "تهران ، میرداماد ، کوچه رازان ، پلاک ۷",
            "tel": "02188624168",
            "email": "[email protected]",
            "site": "http://sample.com",
            "telegram": "http://telegram.me/sample",
            "facebook": "https://www.facebook.com/sample",
            "instagram": "http://instagram.com/instagram",
            "twitter": "https://twitter.com/sample",
            "logo": "https://cdn.hesabit.com/profiles/logo/11/243/small.png",
            "signature": "https://cdn.hesabit.com/profiles/signature/11/243/small.png",
            "default": 1,
            "created": 1460952000
        }
    },
    "success": true,
    "status": 201
}
DELETE /profiles/{profile_id} حذف یک پروفایل

حذف پروفایل

پاک کردن یک پروفایل .

DELETE /profiles/{profile_id}

مقادیر درخواست در آدرس (Path parameters)

profile_id شناسه پروفایل یک رشته ۳۶ کاراکتری منحصر به فرد است .

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

                        curl -X DELETE -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/profiles/50151ea8-1540-429b-8a68-49ef2e65e143?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
  "data": {
    "Profile": {
      "id": "50151ea8-1540-429b-8a68-49ef2e65e143"
    }
  },
  "success": true,
  "status": 200,
  "message": "Profile deleted successfully"
}