User Manual

This document presents RENware Software Systems company data API application provider. It refer the public company data.

For a better understanding read the note section at the end of document.

General information:

product name: RENware Data API
product version: 1.0
product p/n: 0000-0051

Routes general rules

There are 2 kind of routes:

static data GET / READ routes, prefixed as

<BASE_URL>/data_sources/[entity name][/object name]

dynamic API routes that are able for complete CRUD operations to data, prefixed as
```
<BASE_URL>/api/<entity name>/[operation]/<object name>[?query parameters]
```

The parameters mean:

BASE_URL see note 1
entity name is the name of desired data entity. This should be known and represent something like a data "cluster", a data domain, in SQL is most appropriate of "schema". There is no default value.
object name is the name of the data object, equivalent of "table" in SQL. This should be known and there is no default value.
operation is the desired data operation (ie, CRUD like). Operation "codes" are specific and specified for each API route. Default operation is considered the GET / READ one.
query parameters standard sequence of parameters for data querying or modifying (ie, attributes level data). Query parameters start with ? charater followed by attributes and their values. The format for query poo parameters definition is conform to HTML standards.

Other "good to know" rules

Dynamic API routes can have query parameters specified, meaning that they "knows to use" and respond accordingly.
Static routes will ignore any query parameters.

Data formats and meta information

API type is HTTP REST for data purposes. That means the basic and if not otherwise specified, data type is JSON returned as standard HTTP header with application type application/json and UTF-8 encoding.

The JSON objects contains more data structures, but effective data is located under key data^{note 2} which is in mostly cases a list / array of other objects (effective data rows).

Meta information

JSON objects contains an embedded object / dictionary dedicated to information regarding respective object. This oject is at first level in JSON identified by key "meta_info" and has the following structure:

"meta_info": {
    "last_update": "Date as <string> using an ISO format, for example YYYY-MM-DD, ex; 2021-09-30",
    "version": "Version as <SemVer string>, ex; 6.1.8, the patch number being optional",
    "name": "Object code-name as <string>",
    "description": "Object description as <string>"
}

Route methods

The route HTTP methods are:

for static routes always is GET^{note 3}
for dynamic routes all methods are available and are used by each route as needed according to design specs. The API routes catalog present available methods for each route

Getting the information

Information from API can be obtained by making a request from corresponding route (see "Routes general rules" section).

The request can be made from a program (using its specific libraries and rules) or at operating system level by using curl CLI tool available on usual operating systems. The detailed description of curl tool can be found on many sites, for example this one.

The Catalog of all API routes should be consulted to see what information are available and corresponding routes.

Authentications

This API, containing only public data, requires no authentication. However, not public or highly sensitive data can be encrypted and a password is be required to decrypt it.

Notes

(1) BASE_URL represents the server name part of the URL, ie at current version being http://dataapi.renware.eu/ (please be aware to not duplicate last / character)
(2) effective data the effective data in data objects is also called payload term which is an alternate one but complete equivalent
(3) static routes are served normally by a HTTP server type CGI and only serve files from an established directory know as web root directory, so there is any possibility to process other kind of methods tban GET