API

Includes

Enhance your search results with the power of HTTP parameters for precise customization. These parameters enable you to fine-tune your queries and obtain information that precisely aligns with your requirements. By integrating these parameters into your requests, you gain control over the quantity and scope of data returned, ensuring that you receive only the information that's relevant to you.

What makes utilizing HTTP parameters for refining your search results even more potent is the fact that each resource on our platform can offer unique parameters. This means you can find the available parameters specific to each resource's page, enabling you to perform searches tailored to your precise needs. This approach empowers you to have complete control over how you adapt search results to meet your criteria.

Information about specific parameters that can be used to perform a search is provided on the respective resource-specific page. This ensures that users have a clear reference point to understand and effectively use the available parameters to refine their search results.

Include parameters

Our API presents an array of inclusive options designed to enhance the quality of your search outcomes. Here's an illuminating example to illustrate their utilization:

Imagine you're searching for software products with specific features. By utilizing our API's inclusive parameters, you can not only retrieve the basic information about these products but also obtain additional details such as publisher, the latest version, and related resources. This comprehensive approach empowers you to make well-informed decisions by accessing a holistic view of the software landscape. Our API's inclusion feature allows you to extract the most relevant and valuable insights, enabling you to tailor your search results to meet your precise needs.

Example request for Software with the latest version

.../api/v1/software?includeLatestVersion=true

Response

{
  "data": {
    "id": "59b1a685-c007-42d5-81da-a041ac530485",
    "name": "Notepad++",
    "description": "Notepad++ is a free (as in “free speech” and also as in “free beer”) source code editor and Notepad replacement that supports several languages.\nRunning in the MS Windows environment, its use is governed by GNU General Public License.",
    "short_description": "Notepad++ is a free source code editor that supports several languages.",
    "url": "https://notepad-plus-plus.org",
    "latest_version": {
      "version": "8.5.5",
      "created_at": "2023-08-10T01:00:10.000000Z"
    },
    "last_update": "2023-08-11T19:29:36.000000Z",
    "is_favorite": true,
    "links": {
      "self": "http://update-verfuegbar.test/api/v1/software/59b1a685-c007-42d5-81da-a041ac530485",
      "versions": "http://update-verfuegbar.test/api/v1/software/59b1a685-c007-42d5-81da-a041ac530485/versions",
      "publisher": "http://update-verfuegbar.test/api/v1/publisher/cc266ac4-17d8-424c-b248-000df4f9ebe7",
      "favorite": "http://update-verfuegbar.test/api/v1/favorite/30d3df18-646b-4a96-941b-6607a8bcc15c"
    }
  }
}

Combining multiple parameters

By appending the necessary parameters to the URL, you can easily fine-tune your query to extract precise data. This versatile approach enables you to dynamically adjust your requests, utilizing multiple parameters simultaneously to refine your search and obtain comprehensive insights tailored to your specific needs.

Example request for a software with publisher and the latest version

.../api/v1/software?includePublisher=true&includeLatestVersion=true

Response

{
  "data": {
    "id": "59b1a685-c007-42d5-81da-a041ac530485",
    "name": "Notepad++",
    "description": "Notepad++ is a free (as in “free speech” and also as in “free beer”) source code editor and Notepad replacement that supports several languages.\nRunning in the MS Windows environment, its use is governed by GNU General Public License.",
    "short_description": "Notepad++ is a free source code editor that supports several languages.",
    "url": "https://notepad-plus-plus.org",
    "publisher": {
      "id": "cc266ac4-17d8-424c-b248-000df4f9ebe7",
      "name": "Notepad++ Team",
      "url": "https://notepad-plus-plus.org",
      "support_url": "https://notepad-plus-plus.org/online-help",
      "privacy_url": "",
      "created_at": "2023-01-22T10:35:48.000000Z",
      "updated_at": "2023-08-12T13:17:21.000000Z",
      "links": {
        "self": "http://update-verfuegbar.test/api/v1/publisher/cc266ac4-17d8-424c-b248-000df4f9ebe7"
      }
    },
    "latest_version": {
      "version": "8.5.5",
      "created_at": "2023-08-10T01:00:10.000000Z"
    },
    "last_update": "2023-08-11T19:29:36.000000Z",
    "is_favorite": true,
    "links": {
      "self": "http://update-verfuegbar.test/api/v1/software/59b1a685-c007-42d5-81da-a041ac530485",
      "versions": "http://update-verfuegbar.test/api/v1/software/59b1a685-c007-42d5-81da-a041ac530485/versions",
      "publisher": "http://update-verfuegbar.test/api/v1/publisher/cc266ac4-17d8-424c-b248-000df4f9ebe7",
      "favorite": "http://update-verfuegbar.test/api/v1/favorite/30d3df18-646b-4a96-941b-6607a8bcc15c"
    }
  }
}