GPAIS dokumentacija

Appearance

API struktūra ​

Backend teikia REST API per FastAPI. Interaktyvi dokumentacija: gpais.smala.lt/api/docs

Endpointai ​

Bendri ​

MetodasKeliasPaskirtis
GET/api/healthHealth check
POST/api/auth/loginPrisijungimas
GET/api/auth/meDabartinis vartotojas
GET/api/classifiersKlasifikatoriai (su filtravimu pagal tipą)

GII modulis (/api/gii/) ​

MetodasKeliasPaskirtis
GET/api/gii/registrationsRegistracijų sąrašas
GET/api/gii/registrations/{id}Registracijos detalės
GET/api/gii/requestsPrašymų sąrašas
GET/api/gii/requests/{id}Prašymo detalės
POST/api/gii/requestsNaujas registracijos prašymas
PUT/api/gii/requests/{id}Prašymo atnaujinimas
POST/api/gii/requests/{id}/submitPrašymo pateikimas
GET/api/gii/terminationsIšregistravimo prašymai
POST/api/gii/terminationsNaujas išregistravimo prašymas
GET/api/gii/public/registrationsViešas registras
GET/api/gii/mock/jar/{code}JAR integracija (mock)

GIIORG modulis (/api/giiorg/) ​

MetodasKeliasPaskirtis
GET/api/giiorg/licensesLicencijų sąrašas
GET/api/giiorg/licenses/{id}Licencijos detalės
GET/api/giiorg/mandate-holdersMandatų turėtojai
GET/api/giiorg/mandate-holders/{id}Turėtojo detalės
POST/api/giiorg/mandate-holders/{id}/mandatesNaujas mandatas
PUT/api/giiorg/mandates/{id}Mandato atnaujinimas
DELETE/api/giiorg/mandates/{id}Mandato šalinimas
GET/api/giiorg/vup/packagesVUP paketai
GET/api/giiorg/vup/journalsVUP žurnalai
GET/api/giiorg/activity-documentsVeiklos dokumentai
GET/api/giiorg/activity-documents/{id}Dokumento detalės

Autentifikacija ​

JWT token autentifikacija. Token gaunamas per /api/auth/login ir siunčiamas Authorization: Bearer <token> header'yje.

Klasifikatoriai ​

Klasifikatoriai yra bendri reference data, naudojami visuose moduliuose:

TipasPaskirtis
COUNTRYŠalys
MUNICIPALITYSavivaldybės
ORG_TYPEOrganizacijų tipai
OIL_TYPEAlyvų tipai
VEHICLE_CLASSTransporto priemonių klasės
EEE_CATEGORYEEĮ kategorijos
BATTERY_TYPEBaterijų tipai
BATTERY_CHEMISTRYBaterijų cheminė sudėtis
TAXABLE_PRODUCTApmokestinamieji produktai
PACKAGING_MATERIALPakuočių medžiagos
ATTACHMENT_TYPEPriedų tipai
DEREGISTRATION_REASONIšregistravimo priežastys
LICENSE_TYPELicencijų tipai
PARTICIPATION_FORMDalyvavimo formos
BEVERAGE_TYPEGėrimų tipai
PACKAGE_CATEGORYPakuočių kategorijos
PACKAGE_TYPEPakuočių tipai