Commit a48616f7 authored by Boris Budini's avatar Boris Budini
Browse files

Transate dkan_apis.rst

parent da49fa4d
Pipeline #159 failed with stages
in 1 minute and 8 seconds
......@@ -4,63 +4,49 @@
DKAN APIs
=========
In the same way that data on a DKAN site is made accessible to general users through sensory devices like visualizations, dashboards, and data stories, DKAN APIs are essential to developers. DKAN comes with three API’s, the Dataset API, the Datastore API, and the Dataset REST API. These can be queried to discover metadata associated with the catalog or a specific dataset. It can also be harvested by other portals by complying with the API standard data.json.
Në të njëjten mënyrë që të dhënat në një faqe DKAN janë të aksesueshme për vizituesit nëpërmjet grafikëve, data stories, APItë janë thelbësore për zhvilluesit. DKAN vjen me 3 API: API e Dataset, API e Datastore, dhe REST API e Dataset. Këto mund të përdoren për të zbuluar metadata asociuara me një dataset specifik. Ajo mund të përdoret dhe nga portale të tjera për data.json
Datastore API
-------------
The DKAN Datastore houses any CSV files that have been uploaded and then imported into the Datastore. One reason for importing CSV files into the Datastore is to make the file part of the public Datastore API. Allowing data from uploaded files to be included in the Datastore API greatly increases ability to discover the information as well as the usability and accessibility of the data.
DKAN Datastore përmban cdo skedat CSV që është ngarkuar në Datastore. Një arsye për të importuar skedarë CSV është për të bërë skedatë pjesë të Datastore API. Lejimi i përfshirjes së të dhënave në Datastore API rrit aksesueshmërinë në informacion si dhe përdueshmërinë.
Datastore API lejon ndërveprime me Burime specifike në DKAN Datastore deri në rrjeshta speifik. Pa Datastore Api, një saktësi e tillë nuk mund të arrihet
The Datastore API enables interactions with specific Resources in the DKAN Datastore down to specific rows. Without the Datastore API data could not be searched with such precision.
With the Datastore API, technical users can write programs to interact with the information held within the API. This means that the data in the DKAN Datastore can be accurately and efficiently queried (searched) and the data then used in other contexts and applications. The Datastore API is another way to show how open data can be used to provide a tangible return for citizens.
Me Datastore API, përdorues teknik mund të shkruajnë programe që ndërveprojnë me informacionin që përmban API. Kjo do të thotë që DKAN Datastore, mund të jetë e saktë dhe efektive dhe të dhënat të përdoren në mënyrë akoma më të gjërë.
.. figure:: ../../images/site_manager_playbook/DKAN_APIs/datastore_tab_view.png
:alt: datastore api view
Datastore API view on a Resource page.
Using the API
Përdorimi i API
~~~~~~~~~~~~~
For any Resource imported to the Datastore, click Manage the Datastore. Then click the Data API button to get information about the Resource.
You won't perform API queries from here, but you can get linked to a sample query and find :ref:`documentation for more instruction<datastore API>` on how to use the Datastore API. The image below is the information returned on a sample query of the DKAN Datastore using the Datastore API.
Për cdo burim të importuar në Datastore, klikoni Manage the Datastore. Më pas klikoni butonin Data API për të marë informacion rreth burimit.
.. figure:: ../../images/site_manager_playbook/DKAN_APIs/datastore_api_output_unformatted.png
:alt: unformatted datastore API query
This query shows the results in a "raw" form. This is generally more difficult to read, but it is what appears with a standard query.
.. figure:: ../../images/site_manager_playbook/DKAN_APIs/datastore_api_output_formatted.png
:alt: formatted datastore API query
This image shows a formatted view of another API query using a web extension to make the results easier to read.
Dataset API
-----------
The Dataset API works by combining a number of public, supported APIs. Each API is different in what level of detail it pulls out from the information available on a DKAN site. Together, the suite of APIs makes it possible to pull out information with varying specificity. When data is uploaded to DKAN as a Resource or Dataset, it is automatically included in the Dataset API. With the Dataset API, a public data.json file is also automatically published to follow Project Open Data standards.
Dataset API funksionon duke kombinuar një numër të APIve publike të suportuara. Të gjitha API janë ndryshe nga njëra tjetra në nivelin e detajit që ajo ofron. Së bashku, tërësia e API e bën të mundur tërheqjen organike të të dhënave. Kur të dhënat ngarkohen në DKAN si burim ose Dataset, ajo përfshihet automatikisht në Dataset API.
As a Site Manager, you don’t have to worry about managing the Dataset API because all the work happens in the background. At any point you can access the data.json file by simply typing /data.json in the URL after the homepage URL. You’ll get a page with all the information from the Datasets and Resources on your DKAN site.
Si një Menaxhues faqeje ju nuk duhet të shqetësoheni për menaxhimin e API sepse ndodh automatikisht. Ju mund të aksesoni data.json duke shtuar /data.json në fund të URL të faqes tuaj.
.. figure:: ../../images/site_manager_playbook/DKAN_APIs/dataset_api_output_unformatted.png
:alt: formatted data.json
This shows the results in a "raw" form. This is generally more difficult to read, but it is what appears with a standard query.
.. figure:: ../../images/site_manager_playbook/DKAN_APIs/dataset_api_output_formatted.png
:alt: formatted data.json
This shows a formatted view using a web extension to make the results easier to read.
Dataset REST API
----------------
REST continues to be one of the most popular API styles in web development, and it’s quickly becoming the standard for API design. In large part, that’s because REST is designed to be light-weight, fast, portable, and simple to implement.
With REST APIs, external web applications and services can supplement platforms without significant investment or complexity in programmatic communication. The Dataset REST API leverages the opportunities of REST to open greater possibilities on DKAN.
REST vazhdon të jetë një nga format më të famshme të API në zhvillimin e webit, dhe është duke u bërë standarti për API design. Kjo është sepse REST është dizenjuar të jetë e lehtë, e shpejtë, portabël, dhe e thjeshtë.
With the Dataset REST API, you can take action on your DKAN site programmatically. For example, adding a Dataset through the API. For one or two Datasets it might not seem like a drastic difference; but imagine automating the action of adding dozens, or even hundreds, of Datasets. Or imagine you have an application built in-house that you want to integrate with DKAN. The Dataset REST API makes these actions (and many more) possible.
Me REST API, aplikacione web dhe shërbime mund të implementohen pa investim ose kompleksitet të madh në komunikim pragramtik.
We have :ref:`technical documentation on the Dataset REST API<dataset REST API>` that provides more information on how to use it.
Me Dataset REST API, ju mund të merrni veprime pragmatike. Përshëmbull, ju mund të shtoni Datasets nëpërmjet API. Për një ose dy Datasets, mund të mos duket si diference drastike; por imagjinoni automatizimin e shtimin e qindrave Datasets.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment