برای ایجاد یک مشتری جدید از api ذیل استفاده کنید

https://api.satha.ir/api/ApiCustomer/Create

درخواست ارسالی شامل اطلاعات ذیل می باشد:

curl -X 'POST' \
  'https://api.satha.ir/api/ApiCustomer/Create' \
  -H 'accept: text/plain' \
  -H 'Authorization: eyJhbGciOiJIUzI1sdagdhgasdfhrfh...' \
  -H 'Content-Type: application/json' \
  -d '{
  "companyId": "string",
  "companySystemId": "string",
  "companyAccessHash": "string",
  "sex": 0,
  "companyBuyerId": "string",
  "firstName": "string",
  "lastName": "string",
  "fatherName": "string",
  "mobile": "string",
  "email": "string",
  "nationalCode": "string"
}'

مقدار companyId برابر با مقدار Id کمپانی شما که در Response مربوط به api احراز هویت (ApiAccount/Login ) برای شما ارسال شده است

مقدار CompanySystemId از پنل مدیریتی، قسمت سامانه های فعال / توکن های دسترسی  قابل استفاده است.

مقدار companyAccessHash برابر با توکن ایجاد شده شما در پنل کاربری می باشد که از قسمت پنل مدیریتی ( سامانه های فعال / توکن های دسترسی )  در دسترس می باشد

مقدار companyBuyerId برابر با کد یکتای تعریف شده در سیستم یا سامانه شما ( شرکت کاربر ) می باشد، مثلا ممکن است هر کاربر در سیستم شما دارای کد یکتا و یا شماره موبایل باشد، در این صورت به منظور یکسان سازی و استفاده مفیدتر، بهتر است این کد برابر با کد کاربر سامانه شما باشد، تا در استفاده های بعدی به راحتی بتوانید اطلاعات را یکسان سازی کنید و از افزونگی اطلاعات در سامانه خود و ساتا جلوگیری کنید

مقدار firstName برابر با "نام" خریدار است

مقدار lastName برابر با "نام خانوادگی" خریدار است

مقدار fatherName برابر با "نام پدر" خریدار است، این مقدار، غیر اجباری می باشد و می تواند null ارسال شود.

مقدار mobile برابر با شماره موبایل خریدار می باشد.

مقدار email برابر با ایمیل خریدار می باشد/

مقدار mobile و یا email حتما بایستی یکی از این موارد را تکمیل و ارسال کنید، در صورتی که هر دو مورد null باشد درخواست ثبت نمی گردد و خطا به کاربر نمایش داده می شود.

مقدار nationalCode برابر با کد ملی کاربر می باشد، این مقدار غیر اجباری می باشد و در حالاتی که آفر های ویژه برای کاربر در نظر گرفته می شود ارسال می گردد.

همچنین بایستی توکنی که توسط api لاگین ایجاد شده است را به Header این درخواست اضافه و ارسال نمایید، در این صورت درخواست شما به شکل ذیل می شود:

نمونه درخواست ارسالی به شکل ذیل است:

curl -X 'POST' \
  'https://api.satha.ir/api/ApiCustomer/Create' \
  -H 'accept: text/plain' \
  -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySWQiOiI5N...' \
  -H 'Content-Type: application/json' \
  -d '{
   "companyId": "974305c9-324e-47b4-bc49-d805377bcea2",
  "companySystemId": "1281aec0-23a1-492d-bc99-9642fe73182d",
  "companyAccessHash": "7fdf56a186aefcf9f1186d2a29b86921316e019181b61bce149609c4dd4c8557",
  "sex": 1,
  "companyBuyerId": "09123420138",
  "firstName": "کاوه",
  "lastName": "نوروزی",
  "fatherName": "محمد",
  "mobile": "09123420138",
  "email": "kaveh.norozi@gmail.com",
  "nationalCode": "001001001"
}'

در صورتی که درخواست به درستی ارسال گردد پیام برگشتی ذیل ظاهر می شود:

{
  "responseCode": 0,
  "isSuccess": true,
  "message": "اطلاعات مشتری دریافت شد",
  "data": [
    {
      "id": "6121A33F-E4DC-4919-A232-54FC6E805A36",
      "sex": "آقا",
      "companyBuyerId": "09123420138",
      "firstName": "کاوه",
      "lastName": "نوروزی",
      "fatherName": "محمد",
      "mobile": "09123420138",
      "email": "kaveh.norozi@gmail.com",
      "nationalCode": "001001001",
      "userProfileId": null,
      "userCreator": "974305c9-324e-47b4-bc49-d805377bcea2",
      "isActive": true,
      "creationDate": "2024-03-09T17:10:03.14",
      "lastModifiedDate": "0001-01-01T00:00:00",
      "isDeleted": false,
      "deletionDate": "0001-01-01T00:00:00",
      "description": null,
      "status": 1
    }
  ]
}

پیشنهاد می شود، Id برگشتی را در دیتابیس خود ذخیره کنید و در مراجعات و خرید های بعدی این مقدار را CustomerId قرار داده و ارسال کنید

نکته: مشتریان ثبت شده، مختص به شرکت می باشد و توسط شرکت های دیگر قابل مشاهده نمی باشد

 

برای واکشی یا جستجوی یک مشتری خاص می توانید از api ذیل استفاده کنید:

ApiCustomer/GetCustomerData

https://api.satha.ir/api/ApiCustomer/GetCustomerData

درخواست ارسالی برای واکشی اطلاعات به شکل ذیل است:

curl -X 'POST' \
  'https://api.satha/api/ApiCustomer/GetCustomerData' \
  -H 'accept: text/plain' \
  -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc....' \
  -H 'Content-Type: application/json' \
  -d '{
  "companyId": "string",
  "companySystemId": "string",
  "companyAccessHash": "string",
  "mobile": "string",
  "email": "string",
  "nationalCode": "string",
  "companyBuyerId": "string",
  "customerId": "string"
}'

توکن دریافتی از Login را در Header درخواست قرار داده و اطلاعات مورد نیاز را تکمیل و ارسال نمایید.

یکی از موارد فوق را جهت جستجو وارد کنید:

این مقادیر یکتا بوده و امکان ثبت تکراری وجود ندارد

شماره موبایل، ایمیل، CompanyBuyerId و یا CustomerId که در درخواست ایجاد به شما برگردانده می شود.

نمونه درخواست ارسالی به این Api به شکل ذیل است:

curl -X 'POST' \
  'https://api.satha.ir/api/ApiCustomer/GetCustomerData' \
  -H 'accept: text/plain' \
  -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySWQiOiI5NzQzMDVjOS0zMjRlLTQ3YjQtYmM0sImp58hjEhXFk' \
  -H 'Content-Type: application/json' \
  -d '{

   "companyId": "974305c9-324e-47b4-bc49-d805377bcea2",
  "companySystemId": "1281aec0-23a1-492d-bc99-9642fe73182d",
  "companyAccessHash": "7fdf56a186aefcf9f1186d2a29b86921316e019181b61bce149609c4dd4c8557",
  "mobile": "09123420138",
  "email": "",
  "nationalCode": "",
  "companyBuyerId": "",
  "customerId":""
}'

مقدار برگشتی شامل:

{
  "responseCode": 0,
  "isSuccess": true,
  "message": "اطلاعات مشتری دریافت شد",
  "data": [
    {
      "id": null,
      "sex": "آقا",
      "companyBuyerId": "09123420138",
      "firstName": "کاوه",
      "lastName": "نوروزی",
      "fatherName": "محمد",
      "mobile": "09123420138",
      "email": "kaveh.norozi@gmail.com",
      "nationalCode": "001001001",
      "userProfileId": null,
      "userCreator": null,
      "isActive": true,
      "creationDate": "2024-03-09T17:10:03.14",
      "lastModifiedDate": "0001-01-01T00:00:00",
      "isDeleted": false,
      "deletionDate": "0001-01-01T00:00:00",
      "description": null,
      "status": 1
    }
  ]
}

در این درخواست می توانید چندین جستجو را بصورت همزمان انجام دهید، بعنوان مثال:

curl -X 'POST' \
  'https://api.satha.ir/api/ApiCustomer/GetCustomerData' \
  -H 'accept: text/plain' \
  -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....' \
  -H 'Content-Type: application/json' \
  -d '{

   "companyId": "974305c9-324e-47b4-bc49-d805377bcea2",
  "companySystemId": "1281aec0-23a1-492d-bc99-9642fe73182d",
  "companyAccessHash": "7fdf56a186aefcf9f1186d2a29b86921316e019181b61bce149609c4dd4c8557",
  "mobile": "09123420138",
  "email": "",
  "nationalCode": "",
  "companyBuyerId": "123",
  "customerId":""
}'

در درخواست فوق، شماره موبایل 09123420138 و همچنین شماره BuyerId=123 ارسال شده است که هر کدام یک مشتری هستند، در نتیجه مقدار برگشتی بصورت لیستی از Customer برگشت داده می شود.

مقدار برگشتی مورد فوق بصورت:

{
  "responseCode": 0,
  "isSuccess": true,
  "message": "باتوجه به اطلاعات ارسالی، بیش از یک مشتری یافت شد",
  "data": [
    {
      "id": null,
      "sex": "آقا",
      "companyBuyerId": "123",
      "firstName": "kaveh",
      "lastName": "string",
      "fatherName": "string",
      "mobile": "string",
      "email": "string",
      "nationalCode": "string",
      "userProfileId": null,
      "userCreator": null,
      "isActive": true,
      "creationDate": "2024-02-27T18:01:56.923",
      "lastModifiedDate": "0001-01-01T00:00:00",
      "isDeleted": false,
      "deletionDate": "0001-01-01T00:00:00",
      "description": null,
      "status": 1
    },
    {
      "id": null,
      "sex": "آقا",
      "companyBuyerId": "09123420138",
      "firstName": "کاوه",
      "lastName": "نوروزی",
      "fatherName": "محمد",
      "mobile": "09123420138",
      "email": "kaveh.norozi@gmail.com",
      "nationalCode": "001001001",
      "userProfileId": null,
      "userCreator": null,
      "isActive": true,
      "creationDate": "2024-03-09T17:10:03.14",
      "lastModifiedDate": "0001-01-01T00:00:00",
      "isDeleted": false,
      "deletionDate": "0001-01-01T00:00:00",
      "description": null,
      "status": 1
    }
  ]
}