{ "openapi": "3.0.1", "info": { "title": "China NMPA UDI Daily Updates API", "description": "Get medical-device records from China NMPA UDI daily and weekly release files. Preview 100 records or import a complete release, with package integrity checks and structured fields for your ERP or device database.", "version": "0.1", "x-build-id": "gBhYHIdzz1GEmpNKA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~nmpa-udi-daily-updates/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-nmpa-udi-daily-updates", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/automa-flow~nmpa-udi-daily-updates/runs": { "post": { "operationId": "runs-sync-automa-flow-nmpa-udi-daily-updates", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/automa-flow~nmpa-udi-daily-updates/run-sync": { "post": { "operationId": "run-sync-automa-flow-nmpa-udi-daily-updates", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "releaseType": { "title": "Release type", "enum": [ "daily", "weekly" ], "type": "string", "description": "Which official NMPA UDI release feed to read.", "default": "daily" }, "latestOnly": { "title": "Latest package only", "type": "boolean", "description": "When true, ignore date filters and take the newest matching package from the current RSS feed.", "default": true }, "fromDate": { "title": "From date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive YYYY-MM-DD start of the release window. Required when latestOnly is false. NMPA publishes only the latest few packages (observed: 5 daily, 4 weekly); earlier dates return NO_RELEASE and RUN_SUMMARY.coverage reports any gap. Daily windows max 31 calendar days." }, "toDate": { "title": "To date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive YYYY-MM-DD end of the release window. Required when latestOnly is false." }, "maxPackages": { "title": "Max packages", "minimum": 1, "maximum": 31, "type": "integer", "description": "After date selection, process at most this many packages in chronological order (oldest first). If the window matches more packages than this, RUN_SUMMARY.coverage.truncatedByMaxPackages is true and a warning names the remainder. Daily max 31. Weekly requests above 8 are clamped to 8 with a RUN_SUMMARY warning (no failed run).", "default": 1 }, "outputMode": { "title": "Output mode", "enum": [ "preview", "completeRelease" ], "type": "string", "description": "preview downloads and verifies the full package but emits only the first N records with output_scope=PREVIEW. completeRelease emits every validated record.", "default": "preview" }, "previewRecords": { "title": "Preview record limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many records to emit in preview mode (1-500). Ignored for completeRelease.", "default": 100 }, "includeContactList": { "title": "Include registrant contact list", "type": "boolean", "description": "When true, keep source_fields.contactList (registrant contact person phone / e-mail / fax as published by NMPA). Off by default: a device-master sync does not need personal contact data, and dropping it keeps rows minimal.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }