معرفی API

این مستندات API برای وب‌سرویس Rasmio به شما کمک می‌کند تا به راحتی از اطلاعات شرکت‌ها و اشخاص حقیقی استفاده کنید. هدف این مستندات ارائه راهنمایی جامع و ساده برای توسعه‌دهندگان است تا بتوانند از API به صورت بهینه استفاده کنند.

API Rasmio امکان دسترسی به اطلاعات شرکت‌ها و افراد حقیقی در ایران را فراهم می‌کند. شما می‌توانید از این API برای دریافت جزئیات ثبت شرکت‌ها، اعضای هیئت مدیره، آگهی‌های روزنامه رسمی، و سمت‌های اشخاص حقیقی استفاده کنید.

ویژگی‌های کلیدی API:

• دریافت اطلاعات ثبت شرکت‌ها
• جستجوی اشخاص و شرکت‌ها
• دریافت آگهی‌های روزنامه رسمی شرکت‌ها
• دریافت اعضای رسمی شرکت‌ها
• دریافت سمت‌های اشخاص حقیقی
• مشاهده آگهی‌های مرتبط با افراد حقیقی

مراحل شروع استفاده از API:

1. دریافت کلید API (API Key):

   • برای دسترسی به API نیاز به یک کلید API معتبر دارید. این کلید را می‌توانید از بخش تنظیمات حساب کاربری خود در Rasmio دریافت کنید.
   • هر درخواست به API باید شامل کلید API در هدر X-Key باشد.

2. ارسال درخواست‌ها (Requests):

   • تمامی درخواست‌ها باید به صورت HTTPS ارسال شوند.
   • خروجی تمام درخواست‌ها به صورت JSON است.

3. مثال ساده از یک درخواست GET:

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

curl --location --request GET 'https://api.rasm.io/API/Company/14009396050' \
--header 'X-Key: {{XKEY}}'

1. احراز هویت:

برای تمامی درخواست‌ها، کلید API باید به صورت زیر در هدر ارسال شود:

X-Key: {{XKEY}}

1. پاسخ‌ها (Responses):

پاسخ‌ها به صورت JSON شامل اطلاعات کامل درباره شرکت، فرد یا سایر درخواست‌ها باز می‌گردد. در صورت بروز خطا، اطلاعات خطا نیز به صورت JSON بازگردانده می‌شود.

نحوه مدیریت خطاها:

در صورت بروز خطا، API یک پیام خطا با جزئیات مربوط به مشکل در قالب JSON ارسال می‌کند. برخی از کدهای خطا عبارتند از:

• 400 Bad Request: پارامترهای ورودی صحیح نیستند.
• 401 Unauthorized: کلید API اشتباه یا وجود ندارد.
• 403 Forbidden: دسترسی به منابع محدود شده است.
• 404 Not Found: مورد درخواستی پیدا نشد.
• 429 Too Many Requests: تعداد درخواست‌ها از حد مجاز فراتر رفته است.

نمونه پاسخ:

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

{
    "id": 14009396050,
    "registrationNo": "564196",
    "title": "پیشگامان رسمی پردازش دانا",
    "registrationDate": "2020-08-31",
    "capital": 1000000000,
    "address": "تهران، خیابان سهروردی شمالی، پلاک 15",
    "postalCode": "1577956614",
    "status": "فعال",
    "lastUpdate": "2022-06-19"
}