---
title: نظرة عامة على واجهة API
description: نقاط نهاية Human Plugin، وكيف ترتبط ببعضها، وقواعد الاستجابة المشتركة، وما لا توفره الواجهة.
canonical: https://developer.unico.io/ar/human-plugin/api-reference/overview
locale: ar
generated_by: markdown-export
---

# نظرة عامة على واجهة API

ثلاث نقاط نهاية للعمليات ومجسّان للصحة.

يُقدَّم Human Plugin عبر HTTP العادي على المنفذ الذي تضبطه (الافتراضي `8080`). عنوان URL الأساسي هو المكان الذي تعرض فيه الحاوية داخل شبكتك، مثل `http://human-plugin.internal:8080`.

| الطريقة | المسار | الغرض |
| --- | --- | --- |
| `POST` | `/v1/processes` | [إنشاء عملية](/ar/human-plugin/api-reference/create-process)، بأحد [المسارات](/ar/human-plugin/api-reference/create-process#flows) |
| `GET` | `/v1/processes/{id}` | [الحصول على عملية](/ar/human-plugin/api-reference/get-process) |
| `GET` | `/v1/processes/{id}/selfie` | [الحصول على صورة السيلفي](/ar/human-plugin/api-reference/get-selfie) |
| `GET` | `/health/live` | الحيوية (Liveness). راجع [الصحة والمراقبة](/ar/human-plugin/self-hosting/health-and-monitoring) |
| `GET` | `/health/ready` | الجاهزية (فحص قاعدة البيانات) |

لا توجد نقطة نهاية لعرض العمليات أو حذفها أو البحث فيها، ولا مستقبِل webhook.

## القواعد المطبقة على كل استدعاء

- **لا توجد ترويسة مصادقة.** لا يتحقق Human Plugin من جهات الاستدعاء. قيّد الوصول إلى الشبكة بدلاً من ذلك: راجع [الشبكات والأمان](/ar/human-plugin/self-hosting/networking-and-security).
- **JSON فقط**، بأسماء حقول camelCase.
- **الاستجابات بالترويسة `Cache-Control: no-store`.**
- **تستخدم الأخطاء غلافاً واحداً**، `{"message": "INVALID_REQUEST", "details": []}`. راجع [الأخطاء وإعادة المحاولة](/ar/human-plugin/api-reference/errors-and-retries).
- **`id` هو معرّف العملية لدى Human Plugin.** احتفظ به من الإنشاء: فهو وسيلتك لقراءة العملية لاحقاً.

## التسلسل المعتاد

```mermaid
sequenceDiagram
  participant B as Your back-end
  participant H as Human Plugin
  B->>H: POST /v1/processes
  H-->>B: 201 + id, state, data
  B->>H: GET /v1/processes/{id}
  H-->>B: 200 + id, state, data (humanToken, ndocs)
```

التالي: [إنشاء عملية](/ar/human-plugin/api-reference/create-process).