وب هوک تغییرات در رابط برنامه‌نویسی حسابفا


Copyed
URL: https://api.hesabfa.com/v1/setting/SetChangeHook

پارامترهای اجباری:

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
url url مورد نظر برای ارسال تغییرات
hookPassword کلمۀ عبور مورد نظر
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "url": "http://example.url.com",
    "hookPassword": "custom-user-password"
}
Copyed
curl -X POST https://api.hesabfa.com/v1/setting/SetChangeHook \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "url": "http://example.url.com",
    "hookPassword": "custom-user-password"
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token',
    'url' => 'http://example.url.com',
    'hookPassword' => 'custom-user-password'
];

$ch = curl_init("https://api.hesabfa.com/v1/setting/SetChangeHook");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token",
    url: "http://example.url.com",
    hookPassword: "custom-user-password"
};

fetch("https://api.hesabfa.com/v1/setting/SetChangeHook", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token",
    "url": "http://example.url.com",
    "hookPassword": "custom-user-password"
}

response = requests.post(
    "https://api.hesabfa.com/v1/setting/SetChangeHook",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token",
    url = "http://example.url.com",
    hookPassword = "custom-user-password"
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/setting/SetChangeHook", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
    توجه داشته باشید که:
  • پس از تنظیم این متد، تمامی تغییرات انجام شده روی فاکتور، کالاها و خدمات و اشخاص در همان لحظه به URL تنظیم شده فرستاده می‌شود.
  • URL باید وب سرویس REST و متد به‌کار رفتهPOST باشد.
  • اطلاعات در قالبJSON و با فرمت زیر فرستاده خواهد شد.
Copyed
{
    "Password": "custom-user-password",
    "Action": "update",
    "ObjectType": "Product",
    "ObjectIdList": [1, 2, 3]
}
نکته‌های ضروری:
  • Password کلمۀ عبور تنظیم شدۀ کاربر در زمان فراخوانی متد است.
  • مقادیرObjectType عبارتند از: Invoice، Contact و Product.
  • ObjectIdList آرایه‌ای از ماهیت‌های ذخیره شده، تغییر یافته یا حذف شده است.
  • Action برابر با نوع عملیات است (جدول نوع عملیات را ببینید)

آیتم‌هایی موجود در پاسخ:

Result ندارد
Copyed
URL: https://api.hesabfa.com/v1/setting/GetChangeHook

پارامترهای اجباری:

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
Copyed
{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token"
}
Copyed
curl -X POST https://api.hesabfa.com/v1/setting/GetChangeHook \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "your-api-key",
    "loginToken": "your-login-token"
}'
Copyed
<?php
$data = [
    'apiKey' => 'your-api-key',
    'loginToken' => 'your-login-token'
];

$ch = curl_init("https://api.hesabfa.com/v1/setting/GetChangeHook");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
Copyed
const data = {
    apiKey: "your-api-key",
    loginToken: "your-login-token"
};

fetch("https://api.hesabfa.com/v1/setting/GetChangeHook", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
})
    .then(response => response.json())
    .then(result => {
        console.log(result);
    });
Copyed
import requests

data = {
    "apiKey": "your-api-key",
    "loginToken": "your-login-token"
}

response = requests.post(
    "https://api.hesabfa.com/v1/setting/GetChangeHook",
    json=data
)

result = response.json()
print(result)
Copyed
using System.Net.Http.Json;

using var client = new HttpClient();

var data = new
{
    apiKey = "your-api-key",
    loginToken = "your-login-token"
};

var response = await client.PostAsJsonAsync("https://api.hesabfa.com/v1/setting/GetChangeHook", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);

آیتم‌هایی موجود در پاسخ:

apiKey
userId
password
loginToken
پارامترهای اجباری برای تمامی متدها
(مشاهدۀ توضیحات)
Result
url url تعیین شده برای ارسال تغییرات
password کلمۀ عبور تعیین شده
Copyed
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"url": "http://example.url.com",
		"password": "custom-user-password"
	}
}