Documentație API

Utilizatorii care doresc să integreze seturile de date și resursele disponibile pe Portal Open Data Iași în vederea dezvoltării de aplicații web sau destinate dispozitivelor mobile, pot interoga și prelua datele în mod programatic prin intermediului metodelor descrise mai jos. Datele returnate de către API vor fi în format JSON.

GET https://iasi.oras.digital/api/ HTTP/1.1

Seturi de date

Pentru a interoga și prelua detaliile privind seturile de date disponibile în cadrul Portal Open Data Iași, este necesară apelarea metodei resources.

GET https://iasi.oras.digital/api/resources/ HTTP/1.1

Descriere parametrii răspuns metodă resources

• ownerName - numele organizației care a creat setul de date
• categoryName - numele categoriei în care a fost încadrat setul de date
• name - numele setului de date
• slug - codul de identificare unic al setului de date
• description - descrierea setului de date
• _updated - data ultimei modificări asupra setului de date
• _created - data creării setului de date

Resurse

Metoda resource urmată de un cod de identificare al unui set de date va returna detalii privind obiectele (documente PDF/DOC/XLS sau link-uri externe către alte API-uri) din cadrului setului de date interogat.

GET https://iasi.oras.digital/api/resource/ID HTTP/1.1

Descriere parametrii răspuns metodă resource/ID

• name - numele setului de date
• slug - codul de identificare unic al setului de date
• description - descrierea setului de date
• _updated - data ultimei modificări asupra setului de date
• _created - data creării setului de date
• objects - listă de obiecte/resurse asociate setului de date

Descriere parametrii din lista objects

• name - numele resursei / obiectului din cadrul setului de date
• slug - codul de identificare unic al resursei
• description - descrierea resursei din cadrul setului de date
• url - link către resursă (poate fi link către organizația care a creat resursa sau link-ul unui API extern)
• file - link către fișierul atașat resursei pentru a fi descărcat
• format - formatul fișierului atașat (PDF, XML, CSV, DOC, etc.)
• size - dimensiunea fișierului atașat
• _updated - data ultimei modificări asupra resursei
• _created - data creării resursei din cadrul setului de date

API-uri externe

Unele seturi de date din cadrul Portal Open Data Iași au asociate API-uri externe, uneori protejate printr-un mecanism de autentificare. Pentru a prelua datele disponibile, poate fi apelată metoda POST proxy.

POST https://iasi.oras.digital/api/proxy HTTP/1.1

Descriere parametrii POST în format JSON

• action - numele acțiunii (valori permise: fetch)
• type - tipul acțiunii (valori permise: api)
• value - codul de identificare unic al setului de date