Në lidhje me API-në tonë

Hyrje

Kjo faqe shpjegon se si programuesit mund të bëjnë që faqet e internetit dhe softuerat e tjerë të ndërveprojnë me dumeditë nëpërmjet një "API".

dumeditë nuk ka ende një API të plotë, por gradualisht po shtojmë shumë gjëra që janë të ngjashme në përdorim me një API siç kërkohet.

Lidhja me kërkesat e reja

Për të inkurajuar përdoruesit tuaj që të bëjnë lidhje me një autoritet të caktuar publik, përdorni URL të formës /sq/new/komuna_e_gjakoves. Këto janë parametrat që mund t'i shtoni atyre URL-ve, qoftë në URL ose nga një formular. Këta janë parametrat që mund t'i shtoni atyre URL-ve, qoftë në URL ose nga një formular.

• title - përmbledhje e paracaktuar e kërkesës së re.
• default_letter - teksti i paracaktuar i trupit të letrës. Përshëndetja (I dashur...) dhe nënshkrimi (I juaji...) janë mbështjellë rreth kësaj.
• body - si një alternativë ndaj tekstit të paracaktuar të trupit të letrës, kjo cakton të gjithë tekstin e paracaktuar të kërkesës, kështu që ju mund të personalizoni përshëndetjen dhe nënshkrimin.
• tags - lista e etiketave e ndarë nga hapësira, kështu që mund të gjeni dhe lidhni çdo kërkesë të bërë më vonë, p.sh. openlylocal shpenzimet_id:12345. : tregon se është një etiketë makine. Vlerat e etiketave të makinës mund të përfshijnë gjithashtu dy pika, të dobishme për URI-të.

RSS (në fakt, Atom) feed

Ka Atom Feed në shumicën e faqeve që listojnë kërkesat për FOI, të cilat mund t'i përdorni për të marrë përditësime dhe lidhje në formatin XML. Gjeni URL-në e Atom feed në një nga këto mënyra:

• Shikoni për linqe RSS feed.
• Ekzaminoni etiketën <link rel="alternate" type="application/atom+xml"> në kokën e HTML.
• Shtoni /feed në fillimin e një URL-je tjetër.

Në veçanti, edhe pyetjet e ndërlikuara të kërkimit kanë Atom feed. Ju mund të bëni të gjitha llojet e gjërave me to, si p.sh. pyetje sipas autoritetit, sipas llojit të skedarit, sipas intervalit të datave ose sipas statusit. Shikoni këshillat e advanced search tips për detaje

Të dhëna të strukturuara JSON

Shumë faqe kanë versione JSON, të cilat ju lejojnë të shkarkoni informacione rreth objekteve në një formë të strukturuar. Gjeni ato sipas:

• Shtoni .json në fund të URL-së.
• Kërkoni etiketën <link rel="alternate" type="application/json"> në kokën e HTML.

Kërkesat, përdoruesit dhe institucionet kanë të gjithë versione JSON që përmbajnë informacion bazë rreth tyre. Çdo Atom feed ka një ekuivalent JSON, që përmban informacion në lidhje me listën e ngjarjeve në feed.

Tabelë e të gjitha institucioneve

Ekziston një tabelë që liston çdo institucion në dumeditë: all-authorities.csv

5. API për shkrim

API për shkrim është krijuar për t'u përdorur nga institucionet për të krijuar kërkesat e tyre në sistem. Më shumë informacion teknik rreth shkrimit API është i disponueshëm në Alaveteli wiki.