وب سرویس آگهی‌های روزنامه رسمی شرکت‌ها (Company News API)

15 مهر 1403

مستندات API

در این قسمت به بررسی وب‌سرویس آگهی‌های روزنامه رسمی شرکت‌ها (Company News API) می‌پردازیم. این سرویس امکان دریافت تمامی آگهی‌های ثبت‌شده یک شرکت در روزنامه رسمی را فراهم می‌کند.

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

نحوه استفاده:

روش درخواست (HTTP Method): GET

آدرس درخواست (Endpoint):

{{baseUrl}}/Company/{{CompanyId}}/News

جایگزین‌های متغیرها:

{{baseUrl}}: آدرس پایه API (https://api.rasm.io/API)
{{CompanyId}}: شناسه ملی شرکت (مثلاً 14009396050)

پارامترهای ورودی:

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

مثال درخواست:

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

پاسخ نمونه:

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

[
    {
        "id": 15381919,
        "title": "تاسیس آگهی",
        "description": "برای کوتاخی نمونه خروجی از این سند حذف شده است",
        "companyId": 14009396050,
        "capitalTo": 1000000000,
        "newspaperDate": "2020-09-02T00:00:00",
        "newsLetterDate": "2020-08-31T00:00:00",
        "newspaperNumber": "21980",
        "newspaperCityType": "تهران",
        "pageNumber": 14,
        "indicatorNumber": "139930400901059246"
    },
    {
        "id": 15565387,
        "title": "آگهی تغییرات شرکت",
        "description": "برای کوتاخی نمونه خروجی از این سند حذف شده است",
        "companyId": 14009396050,
        "capitalTo": null,
        "newspaperDate": "2020-12-24T00:00:00",
        "newsLetterDate": "2020-12-21T00:00:00",
        "newspaperNumber": "22073",
        "newspaperCityType": "تهران",
        "pageNumber": 42,
        "indicatorNumber": "??????????????????"
    }
]

توضیحات فیلدهای خروجی:

id: شماره داخلی آگهی.
title: عنوان آگهی (مثلاً “تاسیس آگهی” یا “تغییرات شرکت”).
description: متن آگهی که در روزنامه رسمی منتشر شده است.
companyId: شناسه ملی شرکت.
capitalTo: سرمایه جدید در صورت تغییر (در آگهی‌های تغییرات).
newspaperDate: تاریخ چاپ روزنامه رسمی.
newsLetterDate: تاریخ نامه ثبت.
newspaperNumber: شماره روزنامه رسمی که آگهی در آن منتشر شده است.
newspaperCityType: نوع روزنامه (تهران یا شهرستان).
pageNumber: شماره صفحه‌ای که آگهی در آن منتشر شده است.
indicatorNumber: شماره اندیکاتور یا مکانیزه آگهی.

نکات مهم:

برخی آگهی‌ها ممکن است تغییرات مالی یا سازمانی شرکت را شامل شوند. بررسی فیلد capitalTo برای تغییرات سرمایه می‌تواند اطلاعات مفیدی فراهم کند.
برای دریافت آگهی‌های مرتبط با تغییرات، می‌توانید فیلد title و description را تحلیل کنید.

خطاهای احتمالی:

400 Bad Request: پارامتر ورودی شناسه ملی اشتباه است.
404 Not Found: هیچ آگهی‌ای برای شناسه ملی داده‌شده پیدا نشد.
401 Unauthorized: کلید API اشتباه است یا وجود ندارد.

نتیجه‌گیری:

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