Негізгі мазмұнға өту
Signex
RU KK EN

Құжаттама

Жылдам бастау

Signex REST API аутентификацияланған пайдаланушының сертификат деректерін оқуға мүмкіндік береді. Аутентификация cookie арқылы жүзеге асырылады. Барлық жазу эндпойнттары антифоргери-токенмен қорғалған.

Негізгі URL

Барлық сұраныстар мына мекенжайға жіберіледі:

https://signex.kz/api

1. Аутентификация

POST /api/auth/login арқылы кіріңіз. Сервер __Host-Signex.Auth cookie орнатады. Кейінгі барлық сұраныстарда оны және X-XSRF-TOKEN тақырыпшасын қосыңыз.

curl

# Кіру және cookie сақтау
curl -c cookies.txt -X POST https://signex.kz/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"your-password"}'

TypeScript (fetch)

const res = await fetch("https://signex.kz/api/auth/login", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ email: "you@example.com", password: "your-password" }),
});
if (!res.ok) throw new Error(`Кіру сәтсіз: ${res.status}`);

2. Сертификаттар тізімін алу

GET /api/cert/mine ағымдағы пайдаланушының барлық сертификаттарын қайтарады.

curl

curl -b cookies.txt https://signex.kz/api/cert/mine

TypeScript (fetch)

const res = await fetch("https://signex.kz/api/cert/mine", {
  credentials: "include",
});
const { items } = await res.json();
// items: CertSummary[]

Жауап мысалы

{
  "items": [
    {
      "id": "8f7b25d8-4e1a-4c3d-9b12-aef301234567",
      "iin": "123456******",
      "fullName": "АХМЕТОВА АЙГУЛЬ ЕРКИНОВНА",
      "thumbprint": "a1b2c3d4e5f6...",
      "algorithm": "GOST3410-2022",
      "isPrimary": true,
      "validity": {
        "notBeforeUtc": "2024-03-14T10:32:11Z",
        "notAfterUtc":  "2027-03-14T10:32:11Z"
      },
      "status": "valid",
      "template": "Жеке тұлға",
      "linkedAt": "2025-01-10T08:45:00Z"
    }
  ],
  "total": 1
}

3. Сертификат мәліметтері

GET /api/cert/{id} OID кеңейтімдерін қоса алғандағы толық жазбаны қайтарады. 

curl -b cookies.txt \
  https://signex.kz/api/cert/8f7b25d8-4e1a-4c3d-9b12-aef301234567

Сұраныс лимиттері

Эндпойнт Лимит
POST /api/auth/login IP бойынша 5 мин / 10 сұраныс
GET /api/cert/mine пайдаланушы бойынша мин / 60 сұраныс
POST /api/cert/link пайдаланушы бойынша мин / 10; IP бойынша сағат / 30

Келесі қадамдар