Get Started API

You retrieve data from the Technopedia database by making HTTP requests to the Technopedia endpoints.

You retrieve data from the Technopedia database by making HTTP requests to the Technopedia endpoints.

Get an API key

Before you can retrieve data from the Technopedia database, you must contact Flexera Sales or Technical Support to acquire an API key. The API key authorizes you to make HTTP requests to the Technopedia database.

Making HTTP requests to retrieve data from Technopedia

You can use cURL or a third-party API client to get data from the Technopedia database.
Typically, cURL is preinstalled on Mac and Linux computers, and Windows users must install cURL.

The following URL is the base URL for all API queries:
https://data.technopedia.com/

For example, the following example is a cURL query:

curl -G -H "Authorization: Bearer <API_KEY>" "https://data.technopedia.com/tql" --data-urlencode "q=MATCH (n:ASSET) RETURN n LIMIT 5"

You can also use a third-party API client, such as Postman to make API requests as shown in the following image.

Figure 1. API request example with Postman

Parameters

An overview of the parameters that are used by the Technopedia endpoints are described in the following list:

TQL endpoint

For the TQL endpoint, you provide a TQL query that queries the Technopedia database.

The following examples show the endpoint and a query example:

https://data.technopedia.com/tql?q=<TQL Query>
https://data.technopedia.com/tql?q=MATCH (n:ASSET) RETURN n LIMIT 5

Technopedia ID endpoint

For the technopedia-id endpoint, you provide a Technopedia ID.

The following examples show the endpoint and a query example:

https://data.technopedia.com/technopedia-id/<Technopedia ID>
https://data.technopedia.com/technopedia-id/f3f988ff-eb17-4830-95ef-ed1d78c1ac33

Learn more about the Technopedia ID Endpoint.

Software mapping endpoint

For the /mapping/software endpoint, you provide software asset metadata (JSON object) in the request body of a POST request.

The following example shows the endpoint:
POST https://data.technopedia.com/mapping/software

Learn more about the Software Mapping Endpoint.

Hardware mapping endpoint

For the /mapping/hardware endpoint, you provide hardware asset metadata (JSON object) in the request body of a POST request.

The following example shows the endpoint:
POST https://data.technopedia.com/mapping/hardware

Learn more about the Hardware Mapping Endpoint.

Authentication

To authenticate in a new session, you pass the API key in the request header.

In the following examples, an API key example is used with cURL and in the Postman API client.
The key Bearer b93477a9-054b-4878-a16f-d7f5d1f27a7a is used in both examples.
The following example shows the API key in a cURL request:

curl -G -H "Authorization: Bearer b93477a9-054b-4878-a16f-d7f5d1f27a7a" "https://data.technopedia.com/tql" --data-urlencode "q=MATCH (alias:ASSET {class: 'Software'}) RETURN alias LIMIT 10"

You must use the --data-urlencode option in the cURL command to encode spaces.

The following example shows where you add the API key to the header of a GET request in the Postman API client:

Figure 2. Adding an API key in Postman

Try out some queries

Try making HTTP GET requests by using the following queries:

  • https://data.technopedia.com/tql?q=MATCH (alias:ASSET {class: 'Software'}) RETURN alias LIMIT 10
  • https://data.technopedia.com/tql?q=MATCH (alias:ASSET {class: 'Software', type: 'Edition'}) RETURN alias LIMIT 5
  • https://data.technopedia.com/tql?q=MATCH (alias:ASSET {class: 'Hardware', type: 'Model'}) RETURN alias LIMIT 5
  • https://data.technopedia.com/tql?q=MATCH (alias:OWNER {type: 'Manufacturer'}) RETURN alias LIMIT 5

Get Started API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.