Adaptarea integrării la modificările API
Această pagină arată ce modificări trebuie implementate imediat și ce schimbări pot fi planificate ulterior. Statusul unei modificări stabilește prioritatea pentru programator.
Cum se interpretează statusurile
| Status | Ce înseamnă | Acțiunea programatorului |
|---|---|---|
MUST |
Schimbarea este necesară pentru funcționarea corectă a integrării. | Implementează și testează schimbarea înainte de termenul comunicat. |
DEPRECATED |
Funcționalitatea veche este încă acceptată, dar nu mai este recomandată pentru implementări noi. | Migrarea este opțională momentan. Planifică schimbarea, fără să tratezi warning-ul ca eroare. |
OPTIONAL |
Schimbarea aduce o îmbunătățire, dar nu este necesară pentru funcționare. | Implementează doar dacă este utilă integrării. |
Un status DEPRECATED nu înseamnă că funcționalitatea a fost eliminată. Dacă eliminarea devine obligatorie, schimbarea va fi anunțată separat ca MUST, împreună cu termenul aplicabil.
Modificări MUST
Compararea WSDL-ului istoric cu cel curent confirmă două modificări care necesită adaptare:
| Modificare | Înainte | Acum | Adaptare |
|---|---|---|---|
| Endpoint SOAP | http://syncapi.imopedia.ro/index.php?section=api_imopedia&screen=server2 |
https://www.imopedia.ro/soap2, publicat prin WSDL-ul curent |
Actualizează configurația clientului și regenerează clientul SOAP din WSDL-ul curent. |
FileType.ID |
xsd:int |
xsd:string |
Tratează identificatorul din FILE.ID, folosit de deleteFile, ca string și respectă formatul descris în Fișiere media. |
Nu au fost eliminate operații, iar namespace-ul și binding-ul SOAP au rămas neschimbate.
saveBoost, viewAgency și câmpul opțional GOLD au fost adăugate. Aceste adăugări nu cer modificarea integrărilor care nu le folosesc.
Faptul că identificatorul este acum string nu înseamnă că acceptă text arbitrar. FILE_ID și FILE.ID trebuie validate de client ca identificatori alfanumerici sau UUID înainte de trimitere.
Localizare: ORAS, JUDET și REGION_ID
ORAS și JUDET sunt DEPRECATED pentru identificarea regiunii, dar continuă să fie acceptate de API. Renunțarea la ele este opțională momentan.
Pentru integrările existente:
- poți continua să trimiți
ORASșiJUDET; - warning-ul
DEPRECATED_FIELDnu trebuie tratat ca eșec al operației; - migrarea la
REGION_IDpoate fi făcută într-o versiune viitoare a integrării; - nu elimina câmpurile legacy până când maparea către
REGION_IDnu este implementată și testată.
Pentru integrările noi sau pentru codul modificat, folosește REGION_ID din nomenclatorul public de regiuni.
Absența REGION_ID poate produce warning-ul MIGRATION_REQUIRED. Acesta semnalează o adaptare viitoare și nu invalidează singur requestul. Detaliile răspunsurilor sunt documentate în Erori și depanare.
Ordinea recomandată de lucru
- Implementează schimbările marcate
MUST. - Păstrează compatibilitatea pentru câmpurile
DEPRECATED. - Planifică migrările
DEPRECATEDîmpreună cu următoarele modificări relevante ale integrării. - Implementează schimbările
OPTIONALnumai dacă aduc valoare integrării.