Consideratii generale

• Keez expune un API de tip REST din perspectiva modelării resurselor sistemului, fără însă să își propună să atingă ultimul nivel al modelului de maturitate Richardson.

• Resursele sunt identificate unic printr-un ID externalizabil, dacă nu se specifică altfel. Platforma creează ID-ul, care este apoi returnat apelantului.

• Operațiile de listare, creare, modificare și ștergere sunt modelate prin adresarea de verbe corespunzătoare resurselor listate mai jos (GET pentru listă sau acces individual la resursa, POST pentru creare, PUT pentru modificare, DELETE pentru ștergere).

• Operațiile efectuate asupra resurselor sunt modelate prin expunerea altor resurse de tip business logic, cărora clientul le va trimite folosind verbe corespunzătoare. De exemplu, validarea facturii se face printr-un POST în resursa invoices/valid

• Toate exemplele care vor fi furnizate în acest manual sunt realizate în Python

Notă

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