API және интеграция
JSON API /api/v1/… астында. Ағымдағы маршруттар — сіздің орнатуыңыздағы OpenAPI-да. Мысалдарда YOUR_HOST орнына хостыңызды қойыңыз.
Құжаттама
- Интерактив: /docs (қосылған болса).
- Схема:
GET /api/v1/openapi.json. - Статус:
GET /health,GET /readiness,GET /api/v1/status.
Келісімдер
- Өндірісте HTTPS.
Content-Type: application/json(дау бойынша файл жүктеуден басқа).POST /api/v1/auth/loginкейін — cookie және/немесеAuthorization: Bearer ….- Жаңарту:
POST /api/v1/auth/refresh. - Сезімтал операцияларда
Idempotency-Keyқолданылуы мүмкін — OpenAPI қараңыз.
Негізгі топтар
- Auth және сессиялар: register, login, refresh, logout, MFA.
- Профиль және әмиян:
/api/v1/me,/api/v1/wallet/balances,/api/v1/wallet/activity. - Эскроу: create, list, fund, release, dispute.
- Helpdesk: тикеттер.
- Толық тізім — OpenAPI-да.
Интеграцияны қолдау
Кіру және сценарийлер бойынша сұрақтар: анықтама немесе support@evopay.biz. Авторизацияланған клиенттер POST /api/v1/helpdesk/tickets арқылы тикет жасай алады.
Мысалдар
json · сұрау денесі
{
"email": "user@example.com",
"password": "YourStrongPassw0rd!",
"display_name": "Demo User"
}
bash · тіркелу
curl -sS -X POST "https://YOUR_HOST/api/v1/auth/register" \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"password": "YourStrongPassw0rd!",
"display_name": "Demo User"
}'
bash · кіру
curl -sS -X POST "https://YOUR_HOST/api/v1/auth/login" \
-H "Content-Type: application/json" \
-c cookies.txt \
-d '{
"email": "user@example.com",
"password": "YourStrongPassw0rd!"
}'
bash · профиль және әмиян
curl -sS "https://YOUR_HOST/api/v1/me" -b cookies.txt
curl -sS "https://YOUR_HOST/api/v1/wallet/balances" -b cookies.txt
curl -sS "https://YOUR_HOST/api/v1/wallet/activity?limit=20" -b cookies.txt
bash · эскроу жасау
curl -sS -X POST "https://YOUR_HOST/api/v1/escrow" \
-H "Content-Type: application/json" \
-b cookies.txt \
-d '{
"title": "Жабдық жеткізу",
"description": "Спецификация бойынша серверлік жабдық",
"amount": "8000.00",
"currency": "USD"
}'
Содан кейін ESCROW_ID орнын басыңыз:
bash · эскроу өмірлік циклі
curl -sS "https://YOUR_HOST/api/v1/escrow/contracts/ESCROW_ID" -b cookies.txt
curl -sS -X POST "https://YOUR_HOST/api/v1/escrow/ESCROW_ID/fund" \
-H "Content-Type: application/json" -b cookies.txt -d '{}'
curl -sS -X POST "https://YOUR_HOST/api/v1/escrow/ESCROW_ID/release" \
-H "Content-Type: application/json" -b cookies.txt -d '{}'
bash · статус
curl -sS "https://YOUR_HOST/api/v1/status"
curl -sS "https://YOUR_HOST/readiness"