API dokumentācija


Automatizējiet sūtījumu apstrādi ar mūsu Shipment API

Sender.lv piedāvā pilnvērtīgu API komplektu, kas paredzēts sūtījumu un loģistikas procesu automatizācijai un optimizācijai. Mūsu API ļauj uzņēmumiem efektīvi pārvaldīt sūtījumus, nodrošinot piekļuvi plašam piegādes pakalpojumu un loģistikas funkcionalitātes klāstam.

Galvenās iespējas:

  • Pieejamo valstu / galamērķu iegūšana: Saņemiet valstu sarakstu, uz kurām Sender.lv nodrošina piegādes pakalpojumus, lai pārliecinātos par starptautisko sūtījumu pieejamību.
  • Tarifu un piegādes iespēju iegūšana: Aprēķiniet piegādes izmaksas un saņemiet pieejamās piegādes iespējas izvēlētajam galamērķim, lai izvēlētos piemērotāko risinājumu.
  • Pasūtījums: Adrese → Adrese: Izveidojiet un pārvaldiet sūtījumus no vienas fiziskas adreses uz citu. Ideāli piemērots klasiskām piegādēm "no durvīm līdz durvīm".
  • Pasūtījums: Adrese → Pakomāts: Izveidojiet sūtījumus no fiziskas adreses uz pakomātu, nodrošinot saņēmējam ērtu piegādes veidu.
  • Pasūtījums: Pakomāts → Adrese: Organizējiet sūtījumus no pakomāta uz fizisku adresi, nodrošinot lielāku elastību nosūtīšanas un saņemšanas vietas izvēlē.
  • Pasūtījums: Pakomāts → Pakomāts: Izveidojiet sūtījumus starp pakomātiem — drošs un ērts risinājums paku pārsūtīšanai.
  • Pasūtījuma iegūšana pēc Reference numura: Iegūstiet detalizētu informāciju par konkrētu pasūtījumu, izmantojot tā Reference numuru, kas atvieglo sūtījumu uzraudzību un pārvaldību.
  • Pasūtījumu saraksta iegūšana: Iegūstiet visu pasūtījumu sarakstu centralizētai sūtījumu uzraudzībai un pārvaldībai.

Šie API nodrošina uzņēmumiem uzticamus rīkus efektīvai loģistikas procesu pārvaldībai, garantējot ātru, ērtu un uzticamu piegādi klientiem.

Papildu iespējas:

  • Pieejamo saņemšanas datumu un laiku iegūšana katram pārvadātājam: Vairs nav jāmin — vienkārši izvēlieties piemērotāko saņemšanas laiku no API piedāvātā saraksta.
  • Tuvāko pakomātu iegūšana katrai adresei: API automātiski nosaka 10 tuvākos pakomātus izvēlētajai adresei, novēršot nepieciešamību manuāli meklēt pakomātus vai klientam rādīt pilnu sarakstu.
  • Piegādes uzlīmju saņemšana caur Callback URL: Kad pasūtījums ir apstrādāts, piegādes uzlīmes tiek automātiski nosūtītas uz jūsu Callback URL. Šī funkcija novērš nepieciešamību gaidīt ilgstošas servera atbildes un atkārtoti sūtīt pieprasījumus, lai pārbaudītu uzlīmju pieejamību.


Izstrādātāju portāls / Dokumentācija:  https://dev.shipmentapi.com/en


Darba uzsākšana ar Sender API

Pirms sākat izmantot Sender API, jums vispirms jāizveido Sender.lv konts.

  • Izveidojiet kontu mūsu sūtījumu portālā https://new.sender.lv
  • Pabeidziet reģistrāciju, norādot savu e-pasta adresi un tālruņa numuru. Reģistrācijas laikā varat izvēlēties privātpersonas vai juridiskas personas kontu.
  • Paziņojiet mums e-pasta adresi, kuru izmantojāt reģistrācijai — mēs aktivizēsim jūsu kontu darbam ar API.
  • Pēc aktivizēšanas jūs varēsiet izmantot API piekļuves atslēgas un sākt integrācijas testēšanu.


Noklusējuma nosūtītāja adreses izveide

Pēc reģistrācijas un autorizācijas dodieties uz: Mans konts → Adrešu grāmata

Izveidojiet noklusējuma nosūtītāja adresi savam noliktavas, biroja vai interneta veikala objektam. Šī adrese tiks izmantota kā noklusējuma kurjera sūtījumu saņemšanas adrese, kā arī kā atgriešanas adrese nepiegādātiem sūtījumiem.

Lai gan API ļauj katram sūtījumam norādīt citu nosūtītāja adresi, noklusējuma nosūtītāja adreses izveide ir obligāta pirms API izmantošanas.


API integrācijas izveide

Dodieties uz: Mans konts → Iestatījumi → Integrācijas / API

Šeit varat izveidot jaunu API integrāciju un iegūt API piekļuves datus, kas nepieciešami savienojumam ar Sender.lv API.

Aizpildiet integrācijas formu:

  • Nosaukums – integrācijas nosaukums (piemēram, jūsu interneta veikala vai lietojumprogrammas nosaukums).
  • Tips – izvēlieties Custom API Integration.
  • URL – pilns jūsu tīmekļa vietnes vai lietojumprogrammas URL (ieskaitot https://).
  • Statuses URL (nav obligāts) – jūsu webhook adrese, uz kuru tiks nosūtīti sūtījumu statusu atjauninājumi.
  • X-Senderise-Api-Code – slepenā atslēga, ko ģenerē jūsu lietojumprogramma. Tā tiek izmantota pieprasījumu autentiskuma pārbaudei starp jūsu sistēmu un Sender.lv.
  • Noliktavas adrese – izvēlieties noklusējuma nosūtītāja adresi no Adrešu grāmatas (izveidota iepriekšējā solī).

Nospiediet Save, lai izveidotu integrāciju. Pēc tam tiks ģenerēti API piekļuves dati, kurus varēsiet izmantot savā lietojumprogrammā.



API dokumentācija un testēšana

Pilna API dokumentācija ir pieejama šeit: https://dev.shipmentapi.com

  • Reģistrējieties mūsu Izstrādātāju portālā: https://dev.shipmentapi.com/en/client/register
  • Izstrādātāju portālā pieslēdziet savu Sender.lv Sandbox kontu: Account → My Sandboxes (izvēlne augšējā labajā stūrī).
  • Integrācijas izstrādes un testēšanas laikā izmantojiet tikai savu Sandbox API Key.
  • Testējiet API pieprasījumus reāllaikā un iepazīstieties ar dažādiem API izmantošanas scenārijiem vienuviet: API Reference.
  • Pēc veiksmīgas Sandbox testēšanas vienkārši nomainiet Sandbox API Key pret savu Production API Key.

Kādas ir prasības API klientam?

Sender.lv ļoti nopietni izturas pret jūsu un jūsu klientu datu drošību. Pirms sākat izmantot mūsu API, pārliecinieties, ka jūsu HTTP klients atbalsta zemāk norādītos protokolus un drošības prasības.

  • HTTPS (TLS)
  • Sertifikāti. Mūsu SSL sertifikātu ir parakstījis Google Trust Services. Lielākā daļa operētājsistēmu un HTTP klientu automātiski uzticas šiem sertifikātiem. Ja jūsu sistēma neveic automātisku sertifikātu pārbaudi, pievienojiet Google Trust Root Certificate uzticamo sertifikācijas iestāžu (CA) sarakstam. Lūdzu, ņemiet vērā, ka Sender API servera sertifikāts tiek regulāri atjaunots, tādēļ nav ieteicams izmantot konkrēta sertifikāta piesaisti (certificate pinning).
  • HTTP versija. Sender API atbalsta HTTP/1.1 un HTTP/2. HTTP/3 pašlaik netiek atbalstīts. HTTP/1.0 netiek atbalstīts.
  • GET pieprasījumi ar Request Body. Sender API neatbalsta GET pieprasījumus, kuros tiek nosūtīts pieprasījuma saturs (body). Šādos gadījumos API atgriezīs kļūdu 403 Forbidden.
  • IP versija. Pašlaik mūsu API ir pieejams tikai caur IPv4.

Vai API ir pieprasījumu skaita ierobežojumi (Rate Limits)?

Lai nodrošinātu godprātīgu API izmantošanu, novērstu sistēmas pārslodzi un aizsargātu API resursus, tiek piemēroti noklusējuma pieprasījumu skaita ierobežojumi (Rate Limits).

Pēc noklusējuma ir spēkā šādi ierobežojumi:

  • Drošie pieprasījumi (GET): līdz 60 pieprasījumiem minūtē.
  • Ja tiek pārsniegts 60 pieprasījumu limits, piekļuve API tiks automātiski bloķēta uz 1 minūti.

Ja jūsu lietojumprogrammai nepieciešams lielāks pieprasījumu limits, lūdzu, sazinieties ar mums — mēs varam to palielināt atbilstoši jūsu vajadzībām.


Kā autentificēt API pieprasījumus?

  • Pēc Sandbox vai Production API Key saņemšanas pievienojiet to HTTP galvenē x-api-key.
  • Zemāk ir parādīts piemērs, kā autentificēt pieprasījumu Sender API, izmantojot curl:

curl --location 'https://api.sender.lv/api/sandbox/v1/orders' \
--header 'Accept: application/json' \
--header 'x-api-key: 239uw87yhuih87sdf<based-64-encoded-token>'



Nepieciešama palīdzība?

Mēs ar prieku palīdzēsim jums ar jebkādiem jautājumiem par Sender API integrāciju vai jebkuriem citiem tehniskiem jautājumiem.