Cargo Poster API Dokumentacija

Sveiki atvykę į Cargo Poster API dokumentaciją. Mūsų API suteikia programinę prieigą efektyviai valdyti krovinių siuntimus, pasus ir sekti pristatymus.

Bazinis URL

https://cargoposter.lt

Reikalinga autentifikacija

Daugumai galutinių taškų reikalinga autentifikacija naudojant Bearer žetonus. Įsitikinkite, kad įtraukėte savo žetoną į Authorization antraštę.

Autentifikacija

Prisijungimas ir žetono gavimas

Autentifikuokite vartotoją ir gaukite prieigos žetoną API užklausoms.

POST /api/auth/login

Užklausos turinys:

{
  "email": "user@example.com",
  "password": "jūsų_slaptažodis"
}

Atsakymas:

{
  "user": {
    "id": 1,
    "email": "user@example.com",
    "name": "Jonas Jonaitis"
  },
  "token": "jūsų_prieigos_žetonas_čia"
}

Krovinių valdymas

Gauti krovinių sąrašą

Gaukite visų autentifikuoto vartotojo krovinių siuntų sąrašą.

GET /api/cargos

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

Atsakymas:

{
  "data": [
    {
      "id": 1,
      "title": "Elektronikos siunta",
      "weight": 1500,
      "volume": 2.5,
      "pickup_location": "Vilnius, Lietuva",
      "delivery_location": "Berlynas, Vokietija",
      "status": "laukiantis",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 10,
    "per_page": 15
  }
}

Gauti vieną krovinį

Gaukite konkretaus krovinio siuntų informaciją pagal ID.

GET /api/cargos/{id}

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

URL parametrai:

id (skaičius, privalomas): Krovinio ID, kurį norite gauti

Atsakymas:

{
  "data": {
    "id": 1,
    "title": "Elektronikos siunta",
    "description": "Nešiojamieji kompiuteriai ir mobilūs telefonai",
    "weight": 1500,
    "volume": 2.5,
    "pickup_location": "Vilnius, Lietuva",
    "pickup_date": "2024-02-01",
    "delivery_location": "Berlynas, Vokietija",
    "delivery_date": "2024-02-03",
    "status": "laukiantis",
    "cargo_type": {
      "id": 1,
      "name": "Elektronika"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Sukurti krovinį

Sukurkite naują krovinio siuntą.

POST /api/cargos

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

Užklausos turinys:

{
  "title": "Elektronikos siunta",
  "description": "Nešiojamieji kompiuteriai ir mobilūs telefonai",
  "weight": 1500,
  "volume": 2.5,
  "pickup_location": "Vilnius, Lietuva",
  "pickup_date": "2024-02-01",
  "delivery_location": "Berlynas, Vokietija",
  "delivery_date": "2024-02-03",
  "cargo_type_id": 1
}

Atsakymas:

{
  "data": {
    "id": 1,
    "title": "Elektronikos siunta",
    "description": "Nešiojamieji kompiuteriai ir mobilūs telefonai",
    "weight": 1500,
    "volume": 2.5,
    "pickup_location": "Vilnius, Lietuva",
    "delivery_location": "Berlynas, Vokietija",
    "status": "laukiantis",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Atnaujinti krovinį

Atnaujinkite esamą krovinio siuntą pagal jo ID.

PUT /api/cargos/{id}

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

URL parametrai:

id (privalomas): Unikalus krovinio identifikatorius, kurį norite atnaujinti

Užklausos tekstas:

{
  "title": "Atnaujinta elektronikos siunta",
  "description": "Atnaujinti nešiojamieji kompiuteriai ir mobilieji telefonai",
  "weight": 1600,
  "volume": 2.8,
  "pickup_location": "Vilnius, Lietuva",
  "pickup_date": "2024-02-02",
  "delivery_location": "Hamburgas, Vokietija",
  "delivery_date": "2024-02-05",
  "cargo_type_id": 1
}

Atsakymas:

{
  "data": {
    "id": 1,
    "title": "Atnaujinta elektronikos siunta",
    "description": "Atnaujinti nešiojamieji kompiuteriai ir mobilieji telefonai",
    "weight": 1600,
    "volume": 2.8,
    "pickup_location": "Vilnius, Lietuva",
    "delivery_location": "Hamburgas, Vokietija",
    "status": "pending",
    "updated_at": "2024-01-15T11:45:00Z"
  }
}

Klaidų atsakymai:

404 Nerasta:
{
  "message": "Krovinys nerastas"
}

422 Validacijos klaida:
{
  "message": "Pateikti duomenys neteisingi.",
  "errors": {
    "title": ["Pavadinimo laukas yra privalomas."],
    "weight": ["Svoris turi būti teigiamas skaičius."]
  }
}

Pasų valdymas

Gauti pasų sąrašą

Gaukite visų pasų sąrašą krovinių sekimui.

GET /api/passports

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

Atsakymas:

{
  "data": [
    {
      "id": 1,
      "passport_number": "PS001234",
      "cargo_id": 1,
      "status": "aktyvus",
      "issued_date": "2024-01-15",
      "expiry_date": "2024-12-31",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 5,
    "per_page": 15
  }
}

Gauti vieną pasą

Gaukite konkretaus paso informaciją pagal ID.

GET /api/passports/{id}

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

URL parametrai:

id (skaičius, privalomas): Paso ID, kurį norite gauti

Atsakymas:

{
  "data": {
    "id": 1,
    "passport_number": "PS001234",
    "cargo_id": 1,
    "status": "aktyvus",
    "issued_date": "2024-01-15",
    "expiry_date": "2024-12-31",
    "notes": "Reikalingas specialus tvarkymas",
    "cargo": {
      "id": 1,
      "title": "Elektronikos siunta",
      "weight": 1500,
      "volume": 2.5
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Sukurti pasą

Sukurkite naują pasą krovinių sekimui.

POST /api/passports

Antraštės:

Authorization: Bearer jūsų_prieigos_žetonas_čia
Content-Type: application/json

Užklausos turinys:

{
  "cargo_id": 1,
  "passport_number": "PS001234",
  "issued_date": "2024-01-15",
  "expiry_date": "2024-12-31",
  "notes": "Reikalingas specialus tvarkymas"
}

Atsakymas:

{
  "data": {
    "id": 1,
    "passport_number": "PS001234",
    "cargo_id": 1,
    "status": "aktyvus",
    "issued_date": "2024-01-15",
    "expiry_date": "2024-12-31",
    "notes": "Reikalingas specialus tvarkymas",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Klaidų kodai

API naudoja standartinius HTTP atsakymo kodus, kad nurodytų užklausų sėkmę ar nesėkmę.

Būsenos kodas	Reikšmė	Aprašymas
200	Gerai	Užklausa sėkminga
201	Sukurta	Išteklius sėkmingai sukurtas
400	Bloga užklausa	Neteisingi užklausos parametrai
401	Neautorizuota	Reikalinga autentifikacija
403	Uždrausta	Prieiga uždrausta
404	Nerasta	Išteklius nerastas
422	Neapdorojamas vienetas	Validacijos klaida
500	Vidinė serverio klaida	Serverio klaida

Naudojimo apribojimai

API naudoja greičio apribojimus, kad užtikrintų sąžiningą naudojimą. Kiekvienas autentifikuotas vartotojas yra apribotas iki:

1000 užklausų per valandą standartiniams galutiniams taškams
100 užklausų per valandą duomenų intensyviems galutiniams taškams
Greičio apribojimo antraštės įtrauktos į visus atsakymus

Pagalba

Jei turite klausimų apie API naudojimą arba susidūrėte su problemomis, nedvejodami kreipkitės:

Pagalba: Susisiekite su mumis

API Dokumentacija

Cargo Poster API Dokumentacija

Bazinis URL

Reikalinga autentifikacija

Autentifikacija

Prisijungimas ir žetono gavimas

Užklausos turinys:

Atsakymas:

Krovinių valdymas

Gauti krovinių sąrašą

Antraštės:

Atsakymas:

Gauti vieną krovinį

Antraštės:

URL parametrai:

Atsakymas:

Sukurti krovinį

Antraštės:

Užklausos turinys:

Atsakymas:

Atnaujinti krovinį

Antraštės:

URL parametrai:

Užklausos tekstas:

Atsakymas:

Klaidų atsakymai:

Pasų valdymas

Gauti pasų sąrašą

Antraštės:

Atsakymas:

Gauti vieną pasą

Antraštės:

URL parametrai:

Atsakymas:

Sukurti pasą

Antraštės:

Užklausos turinys:

Atsakymas:

Klaidų kodai

Naudojimo apribojimai

Pagalba

Puslapiai

Resursai

Rekomenduok kolegai