Rivile ERP — viešasis REST API (OpenAPI apžvalga)

Rivile ERP — viešasis REST API (OpenAPI apžvalga)

Gidas (oficialus aprašymas LT): rivile-erp-guide-api.html — sutraukta iš guide.rivile.cloud/api ir susijusių puslapių.

GraphQL (vidinė schema, apžvalga): rivile-erp-graphql-overview.html — pilnas domenų modelis, Query / Mutation, sesijos tipai, automatizavimo mutacijos; kanoninis failas rivile-erp-graphql.schema.graphql (įkeliamas rankiniu būdu).

OpenAPI: 3.0.1 · API pavadinimas: Rivile ERP Public API · Versija: 0.1

Bazinis URL: https://erp.rivile.cloud/public-api

Swagger UI: https://erp.rivile.cloud/public-api/swagger-ui/index.html

Pilna schema (failas): rivile-erp-public-api.openapi.json

(atsisiuntimas iš serverio be X-SessionToken dažnai grąžina 401 — naudokite šį failą arba naršyklėje prisijungę per Swagger.)

Kaip įkelti pilną .openapi.json į šį katalogą

  1. Iš serverio (rekomenduojama atnaujinimams): docs/fetch-public-openapi.sh — nustatykite RIVILE_SESSION_TOKEN (reikšmė iš antraštės X-SessionToken) ir paleiskite; failas bus įrašytas kaip rivile-erp-public-api.openapi.json. (Tiesioginis GET /v3/api-docs be šio antraštės dažnai grąžina 401.)
  2. Iš pokalbio / eksporto: įrašykite gautą OpenAPI JSON (viena eilutė ar suformatuota) į docs/rivile-erp-public-api.openapi.json. Patikra: python3 -m json.tool docs/rivile-erp-public-api.openapi.json > /dev/null. (Labai didelė schema gali viršyti vieno įrankio įrašymo limitą — tuomet įkelkite failą per redaktorių arba padalinkite ir sujunkite žingsniu 3.)
  3. Sujungimas iš dviejų dalių (jei schema išskaidyta ties ,"components":{"schemas"): docs/merge-openapi-parts.sh head.json tail.json.

Saugumas

  • Tipas: apiKey
  • Antraštė: X-SessionToken
  • Globalus security: [{ "apiKey": [] }]

Bendri užklausų parametrai

Parametras Vieta Aprašymas
page query Puslapis (numatytai "0", min 0)
size query Puslapio dydis (numatytai "30", 1–100)
filter query Filtrų masyvas: name, value, operation (CONTAINS, EQUAL, GREATER_THAN, …)
Accept-Language header lt arba en

Atsakymai: dažnai ListPageResponse* su totalElements, totalPages, content; klaidos — ErrorResponse (code, values).

Keliai pagal sritis (santrauka)

Grupė Keliai (trumpai)
Health GET /health/status
API raktas GET /v1/users/api-keys — validuoti sesiją / raktą
Darbo laikas GET/POST /v1/timesheets, GET/POST /v1/timesheet-schedules, GET .../schedules/{id}/days
Pardavimų užsakymai GET/POST /v1/sale-orders, GET/DELETE /v1/sale-orders/{id}, POST .../lines, PATCH workflow, reserve, approve, convert quote/order ir kt.
Pardavimo SF GET/POST /v1/sale-invoices, GET/DELETE /v1/sale-invoices/{id}, POST .../lines, POST .../fixed-payments, POST .../from/sale-order/{id}, PATCH post, cancel, reserve, workflow ir kt.
Pirkimo SF Analogiškai po /v1/purchase-invoices
Produktai GET/POST /v1/products, GET/PATCH /v1/products/{id}, POST .../product-uom, POST .../price, PATCH .../workflow-status, PATCH .../product-uom/{id}
Pardavimo kainos GET /v1/sale-prices, GET /v1/sale-prices/{id}
Mokėjimai GET/POST /v1/payments, GET /v1/payments/{id}, keli PATCH (post, cancel, link-payment, workflow)
PR registro sąrašas GET /v1/pr-registries
Atsargos GET /v1/inventory-stocks
Inventorizacija GET/POST /v1/inventory-adjustments, GET/DELETE .../{id}, POST .../lines, PATCH post/unpost
Atsargų judėjimai (kelias schemoje: inventor-movements — be „y“) GET/POST /v1/inventor-movements, eilutės, workflow, post
Pristatymai GET/POST /v1/deliveries, GET/PATCH/DELETE .../{deliveryId}, eilutės, workflow, post
Kontaktai GET/POST /v1/contacts, GET/PATCH /v1/contacts/{id}
Klientai GET/POST /v1/clients, GET/PATCH /v1/clients/{id}, PATCH .../workflow-status
Darbuotojai GET /v1/employees
Workflow būsenos GET /v1/workflow-statuses/{entityTypeId}, GET .../{entityTypeId}/{companyId}

Pastabos mokymams

Schema failo atnaujinimas

Jei API evoliucionuoja, atnaujinkite rivile-erp-public-api.openapi.json (eksportas iš Swagger arba kopija iš /v3/api-docs su galiojančiu X-SessionToken).