بازگشت به صفحه سازمانی
نسخه ۱.۰.۰

مستندات وب‌سرویس‌های ثبت پرونده آنی‌یاب

راهنمای فنی یکپارچه‌سازی سرویس‌های ثبت و جستجوی پرونده برای سازمان‌ها و توسعه‌دهندگان

احراز هویت

برای استفاده از سرویس‌هایی که نیاز به احراز هویت دارند، ابتدا توکن دریافت کنید.

دریافت توکن

POST https://aniyab.com/api/app/users/auth
پارامترتوضیحنوع
Identityکد ملی، شماره موبایل یا نام کاربریstring
Passwordرمز عبورstring
ClientIdمقدار ثابت: Aniyab_Mobile2string

دریافت Refresh Token

POST https://aniyab.com/api/app/users/auth/refresh
پارامترتوضیح
RefreshTokenرفرش‌توکن فعلی
ClientIdمقدار ثابت: Aniyab_Mobile2

وب‌سرویس‌های پیش‌نیاز

موجودیت پرونده‌ها در آنی‌یاب وابستگی‌های از پیش تعریف‌شده دارد. توسعه‌دهنده کافی است این داده‌ها را فراخوانی و در درخواست ثبت پرونده جای‌گذاری کند.

دریافت لیست استان‌ها

لیست تمامی استان‌ها شامل شناسه و نام.

GET https://aniyab.com/api/app/public-api/get-list-provinces 
{
  "id": "5bea91b0-fd48-4d04-bd54-9355d899545d",
  "title": "لرستان"
}

دریافت لیست شهرها

لیست شهرها شامل شناسه، نام و شناسه استان مربوطه.

GET https://aniyab.com/api/app/public-api/get-list-cities 
{
  "id": "bcee4e39-a455-455a-a15a-3941c586c831",
  "title": "دورود",
  "provinceId": "5bea91b0-fd48-4d04-bd54-9355d899545d"
}

دریافت لیست محصولات مژدگانی

GET https://aniyab.com/api/app/public-api/get-list-reward-products 
{
  "id": "8a1db491-7101-3f0b-c85e-3a0c3a7bfeed",
  "title": "برچسب 10 عددی"
}

دریافت لیست محصولات ردیابی موبایل

GET https://aniyab.com/api/app/public-api/get-list-mobile-tracking-products 
{
  "id": "a17b24e2-d422-57c6-2c29-3a13639ac08d",
  "title": "ردیابی موبایل 150 روزه"
}

دریافت لیست برندهای موبایل

GET https://aniyab.com/api/app/public-api/get-list-phone-brands 
{
  "id": "7857132a-370a-5f1f-003b-3a0fa9cb8c7b",
  "title": "اپل"
}

دریافت لیست آیتم‌های گمشده یا پیداشده

خروجی شامل شناسه، نام، ترتیب نمایش و ویژگی‌های هر آیتم است. هر ویژگی دارای شناسه، عنوان، توضیحات، ترتیب، اجباری بودن و الگوی Regex می‌باشد.

GET https://aniyab.com/api/app/public-api/get-list-documents-with-properties 
[
  {
    "id": "c277840b-c327-a3b5-0f1e-3a0c3a7c5a3e",
    "title": "لپ تاپ",
    "order": 0,
    "properties": [
      {
        "id": "7d8a83e0-edf7-f20f-2000-3a0c3a7c5a3e",
        "title": "برند لپ تاپ",
        "description": "برند گمشده را وارد کنید",
        "order": 0,
        "isRequired": true,
        "regexValidationPattern": null
      }
    ]
  }
]
برای ثبت «لپ‌تاپ»، فیلد «برند لپ‌تاپ» اجباری است و باید توسط کاربر تکمیل شود.

ثبت پرونده گمشده یا پیداشده

پارامترهای ورودی به دو دسته تقسیم می‌شوند: اطلاعات مستقیم کاربر و شناسه‌هایی که از وب‌سرویس‌های پیش‌نیاز دریافت می‌شوند.

ثبت پرونده پیداشده

POST https://aniyab.com/api/app/public-api/create-found-case
پارامترتوضیحنوع
finderNameنام یابندهstring
finderLastNameنام خانوادگی یابندهstring
finderPhoneNumberشماره موبایل یابندهstring
lostItemNationalCodeکد ملی مرتبط با آیتم پیداشدهstring
lostItemAniyabSerialسریال آنی‌یاب مرتبط با آیتمstring
foundItemsآرایه اشیای پیداشده (شناسه + properties)array

پس از ثبت موفق، یک Guid به‌عنوان شناسه پرونده برگردانده می‌شود.

ثبت پرونده گمشده

POST https://aniyab.com/api/app/public-api/create-lost-case
پارامترتوضیحنوع
ownerNameنام مالکstring
ownerLastNameنام خانوادگی مالکstring
ownerFatherNameنام پدر مالکstring
ownerNationalCodeکد ملی مالکstring
ownerAniyabSerialسریال آنی‌یاب مالکstring
ownerPhoneNumberشماره موبایل مالکstring
lostDateتاریخ گم شدنDateTime
provinceIdشناسه استان سکونتGuid
cityIdشناسه شهر سکونتGuid
regionمنطقه سکونتstring
streetخیابان سکونتstring
lostItemsآرایه اشیای گمشدهarray
rewardProductIdشناسه محصول مژدگانی (اختیاری)Guid

ثبت پرونده گوشی سرقتی

POST https://aniyab.com/api/app/public-api/create-phone-lost-case

برای phoneBrand پس از دریافت لیست برندها، نام برند را به‌صورت رشته ارسال کنید. برای selectedProductId از وب‌سرویس محصولات ردیابی موبایل استفاده کنید.

پارامترتوضیحنوع
ownerNameنام مالکstring
ownerLastNameنام خانوادگی مالکstring
ownerFatherNameنام پدر مالکstring
ownerNationalCodeکد ملی مالکstring
ownerAniyabSerialسریال آنی‌یاب مالکstring
ownerPhoneNumberشماره موبایل مالکstring
phoneBrandنام برند (از لیست برندها)string
imeI1 / imeI2شماره IMEI دستگاهstring
lostDateتاریخ سرقت/گم شدنDateTime
selectedProductIdشناسه محصول ردیابی موبایلGuid
پس از ثبت موفق هر نوع پرونده، یک Guid به‌عنوان شناسه پرونده ساخته‌شده برگردانده می‌شود.

نمونه JSONهای استفاده‌شده

Found Case — پرونده پیداشده

{
  "finderName": "امیرحسین",
  "finderLastName": "هداوند",
  "finderPhoneNumber": "09365093716",
  "lostItemNationalCode": "",
  "lostItemAniyabSerial": "12345678",
  "foundItems": [
    {
      "id": "c277840b-c327-a3b5-0f1e-3a0c3a7c5a3e",
      "properties": [
        {
          "id": "7d8a83e0-edf7-f20f-2000-3a0c3a7c5a3e",
          "value": "مک بوک"
        }
      ]
    }
  ]
}

Lost Case — پرونده گمشده

{
  "ownerName": "امیرحسین",
  "ownerLastName": "هداوند",
  "ownerFatherName": "اسماعیل",
  "ownerNationalCode": "4901289632",
  "ownerAniyabSerial": "12345678",
  "ownerPhoneNumber": "09365093716",
  "lostDate": "2025-02-04T08:32:02.981Z",
  "provinceId": "",
  "cityId": "",
  "region": "4",
  "street": "ستارخان",
  "lostItems": [
    {
      "id": "c277840b-c327-a3b5-0f1e-3a0c3a7c5a3e",
      "properties": [
        {
          "id": "7d8a83e0-edf7-f20f-2000-3a0c3a7c5a3e",
          "value": "مک بوک"
        }
      ]
    }
  ],
  "rewardProductId": "7d8a83e0-edf7-f20f-2000-3a0c3a7c5a3e"
}

Phone Lost Case — گوشی سرقتی

{
  "ownerName": "امیرحسین",
  "ownerLastName": "هداوند",
  "ownerFatherName": "اسماعیل",
  "ownerNationalCode": "4901289632",
  "ownerAniyabSerial": "12345678",
  "ownerPhoneNumber": "09365093716",
  "phoneBrand": "اپل",
  "imeI1": "359603087204549",
  "imeI2": "352829096791013",
  "lostDate": "2025-02-05T11:02:28.101Z",
  "selectedProductId": "44ac3a11-fcfc-2145-f1cc-3a13639998ec"
}

نیاز به دسترسی سازمانی دارید؟

برای دریافت حساب API، فعال‌سازی محیط تست و پشتیبانی فنی با تیم آنی‌یاب تماس بگیرید.

درخواست دسترسی API