Consideratii generale

• Keez expune un API de tip REST din perspectiva modelarii resurselor sistemului, fara insa sa isi propuna sa atinga ultimul nivel al modelului de maturitate Richardson.

• Resursele sunt identificabile unic printr-un ID externalizabil, daca nu se specifica altfel. ID-ul este creat de platforma si returnat apelatorului.

• Operatiile de listare, creare, modificare si stergere sunt modelate prin adresarea de verbe corespunzatoare resurselor listate mai jos (GET pentru lista/acces individual la resursa, POST pentru create, PUT pentru modificare, DELETE pentru stergere).

• Operatiile efectuate asupra resurselor sunt modelate prin expunerea altor resurse de tip business logic, carora clientul le va trimite apeluri cu verbe corespunzatoare. De exemplu, validarea facturii se face printr-un POST in resursa invoices/valid (obtinuta prin substantivizarea actiunii)

• Toate exemplele care vor fi furnizate in acest manual sunt realizate in Pyton

Notă

Pentru a vedea modul de utilizare la general a API -ului: Vezi Mod de Utilizare API