API NEMOEXPRESS

Versiunea 1.0

NemoExpress™ Documentatie API versiunea 1.0

1
Serviciul de automatizare de generare de AWB-uri si urmarirea stadiului de livrare a
acestora. Prin intermediul acestui serviciu pot fi generate automat AWB-uri, printare de
documente si urmarire in timp real a oricarei expedieri.
Procedura de trimitere este foarte simpla si se se va face prin request catre API-ul
NemoExpress, implementarea facandu-se de catre beneficiar, indiferent de mediul de
dezvoltare sau sistemul de operare ales.
Pentru a putea folosi acest serviciu sunt necesari urmatorii pasi:

1. Trebuie sa aveti cel putin o cheie valida pentru accesarea serviciilor

NemoExpress. Fiecare punct de lucru putand avea o cheie unica de identificare.
2. Dezvoltarea programarii pentru a trimite cererile catre link-urile date si
interpretarea raspunsurilor primite

URL
URL-ul generic pentru accesarea API-ului este:
https://app.nemoexpress.ro/nemo/API/<operation>?api_key=<api key>&…
Cheia API va fi creata si furnizata de Nemo Express.

Valori returnate
Toate raspunsurile sunt de tip JSON, cu urmatoarele campuri:
– status poate fi “done”, “forbidden” sau “failed”
– message este un camp text care de regula explica statusul
– data contine raspunsul detaliat.

API-ul poate fi testat folosind adresa urmatoare:

https://app.nemoexpress.ro/nemo/test_api.html

Creaza expeditie
API/create_awb?api_key=<api key>
Urmatoarele campuri pot fi adaugate:
“type”, “service_type”, “retur”, “retur_type”, “ramburs”, “ramburs_type”, “insurance”, “weight”,
“content”, “comments”, “cnt”,
from_name, from_contact, from_str, from_nr, from_bl, from_sc, from_et, from_ap, from_interfon,
from_sector, from_city, from_county, from_zipcode, from_country, from_phone,
to_name, to_contact”, to_str, to_nr, to_bl, to_sc, to_et, to_ap, to_interfon, to_sector, to_city,
to_county, to_country, to_zipcode, to_phone, to_extra
type: plic | colet
service_type: se obtine de la firma de curierat (ex: regular, express)
retur: 0 | 1 – schimb colet
cnt: number de colete/plicuri
retur_type: colet | document
ramburs: <suma ramburs>
ramburs_type: cont | cash – tip ramburs (daca expeditorul primeste suma ramburs in cont sau
cash)
weight: <greutate in kg>
insurance: valoare asigurata
from_… campurile sunt folosite pentru adresa expeditorului, fields are used for, to_… campurile
pentru adresa destinatarului
…name: nume, numele firmei daca e cazul

NemoExpress™ Documentatie API versiunea 1.0

2
 …contact: persoana de contact din cadrul firmei
…str: strada
…nr: numarul strazii
…bl: bloc
…sc: scara
…interfon: numar interfon
to_extra: orice informatii extra despre adresa destinatarului
use_default_from_address: if “true”, va prelua adresa de expeditie implicita din sistem in locul
campurilor de mai sus.
Nu exista campuri obligatorii, cu exceptia api_key, dar trebuie sa stii este foarte probabil ca
expeditiile carora le lipsesc informatii relevante sa nu fie livrate.
Expeditiile cu “cnt” setat la valori peste 1 vor fi automat convertite in partide. Vei primi ca raspuns
numarul primului colet din partida (spre exemplu “XXX”), iar restul vor fi create astfel:
Primul colet:XXX
Al doilea colet:XXX/2
Al treilea colet:XXX/3
Si asa mai departe.

Camp Valori valide Observatii

payer client Taxele de transport se vor aloca la contractul clientului expeditor.
expeditor Taxele de transport se vor incasa la preluare.
destinatar Taxele de transport se vor incasa la livrare.
service_type standard Tipul de serviciu folosit de NemoExpress.

Orice numar pentru servicii extra (cum ar fi “Livrare sambata”) poate fi precizat, prin adaugarea
unui parametru precum service_<service id> cu valoarea true. Spre exemplu daca “Livrare
sambata” are id 57, vei avea: service_57=true
Lista completa a serviciilor disponibile poate fi obtinuta prin API folosind URL-ul:
API/list_services?api_key=<api key>

Valoare returnata

Campul date contine o harta cu expeditia creata. Numarul expeditiei este in campul “no”.
Statusul pentru expeditia creata va fi implicit neridicat.

awb_event_handler este un parametru optional care poate fi folosit la crearea unui awb. Contine
un URL la care sistemul va trimite un eveniment de apelare- POST solicitari ce contin o mapa
JSON cu urmatoarele campuri:
● awb – numar awb
● status – status awb
Acum sistemul trimite evenimente pentru schimbarea statusului.
Eventurile se trimit asincron, cu o intarziere de maxim 60 secunde.

Preia tarif expeditie

API/get_price?api_key=<api key>
Preia aceeasi parametri ca API_creazaAWB, si returneaza o harta cu campurile “pret: si “zona”

NemoExpress™ Documentatie API versiunea 1.0

3
 Printeaza AWB
API/print?api_key=<apikey>&awbno=<awbno>
Returneaza versiunea HTML a awb-ului tiparit.
Daca vrei sa salvezi awb-ul in format pdf adauga &pdf=true
Poti schimba formatul cu parametrul format, cu valorile legale: a6, default. Valoarea implicita
(default) este aproximativ a5.

Preia status expeditie:

API/get_status?api_key=<apikey>&awbno=<awbno>
Returneaza un text cu statusul curent al expeditiei.
Schimba status expeditie:
API/change_status?api_key=<apikey>&awbno=<awbno>&status=<newstatus>
Schimba statusul expeditiei. Poate fi folosit pentru a schimba statusul din initial in neridicat si din
neridicat in in curs. Poate fi de asemenea folosit pentru a anula o expeditie, daca este acordata
permisiunea de a face asta.

Preia info expeditie:

API/get_info?api_key=<apikey>&awbno=<awbno>
Returneaza o harta JSON care contine:
● campurile text cu informatiile expeditiei (“id”, “no”, “status”, “from_address”, “to_address”,
“from_city”, “to_city”, “from_country”, “to_country”, “ramburs”, “ramburs_type”)
● “invoice”, care contine o harta cu detaliile facturii (data in format unixtime, serie, numar, valoare,-
valoare factura fara TVA)
● “decont_client”, care contine o harta cu datele despre setarile clientului: data in format unixtime,
numar_tranzactie, valoare
Preia istoric expeditie:
API/get_history?api_key=<apikey>&awbno=<awbno>
Returneaza o harta JSON cu campurile: “no”, “status” si “history”, unde history este o lista cu
schimbari de status cu campurile: data (unixtime), status si descriere
Anuleaza o expeditie:
API/cancel?api_key=<apikey>&awbno=<awbno>
Returneaza “ok” in cazul unei reusite, sau “forbidden” daca cheia API a clientului nu are
permisiunea de a anula expeditii.
Preia lista orase:
API/list_cities?api_key=<apikey>
Returneaza o lista JSON cu orase, cu campurile “name” si “province” pentru fiecare.
Ciclul de viata al unei expeditii
O expeditie poate avea urmatoarele statusuri:
● initial - poate inca fi editata de client. Nu este gata pentru ridicare
● neridicat – este gata si asteapta sa fie ridicat
● in_curs – este in livrare
● livrat – expeditia a fost livrata cu succes
● returnat – expeditia a fost returnata din anumite cauze
● anulat – expeditia a fost anulata inainte de a fi preluata
● exceptie – orice altceva

NemoExpress™ Documentatie API versiunea 1.0

4