Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/api/authentication.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- --8<-- [start:authentication] -->

# Authentication

RTDIP REST APIs require Azure Active Directory Authentication and passing the token received as an `authorization` header in the form of a Bearer token. An example of the REST API header is `Authorization: Bearer <<token>>`
Expand All @@ -17,4 +19,6 @@ If a developer or business user would like to leverage the RTDIP REST API suite,

Ensure to install the relevant package and obtain a token.

See the [examples](./examples.md) section to see various authentication methods implemented.
See the [examples](https://www.rtdip.io/api/examples/) section to see various authentication methods implemented.

<!-- --8<-- [end:authentication] -->
8 changes: 7 additions & 1 deletion docs/api/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<center> ![rest](images/rest-api-logo.png){width=50%} </center>

<!-- --8<-- [start:restapi] -->

# RTDIP REST APIs

RTDIP provides REST API endpoints for querying data in the platform. The APIs are a wrapper to the python [RTDIP SDK](../sdk/overview.md) and provide similar functionality for users and applications that are unable to leverage the python RTDIP SDK. It is recommended to read the [RTDIP SDK documentation](../sdk/overview.md) and in particular the [Functions](../sdk/code-reference/query/functions/time_series/resample.md) section for more information about the options and logic behind each API.
RTDIP provides REST API endpoints for querying data in the platform. The APIs are a wrapper to the python [RTDIP SDK](https://www.rtdip.io/sdk/overview/) and provide similar functionality for users and applications that are unable to leverage the python RTDIP SDK. It is recommended to read the [RTDIP SDK documentation](https://www.rtdip.io/sdk/overview/) and in particular the [Functions](https://www.rtdip.io/sdk/queries/functions/) section for more information about the options and logic behind each API.

RTDIP API's are designed with the intention of running small to medium queries, rather than large queries to reduce network latency, increase performance and maintainability.

<!-- --8<-- [end:restapi] -->
15 changes: 14 additions & 1 deletion docs/api/rest_apis.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@

# RTDIP REST API Endpoints

RTDIP REST API documentation is available in a number of formats, as described below.

<center> ![rest](images/open-api.png){width=50%} </center>

<!-- --8<-- [start:openapi] -->

RTDIP REST APIs are built to OpenAPI standard 3.0.2. You can obtain the OpenAPI JSON schema at the following endpoint of your deployed APIs `https://{domain name}/api/openapi.json`

<!-- --8<-- [end:openapi] -->

<center> ![rest](images/swagger.png){width=50%} </center>

<!-- --8<-- [start:swagger] -->

It is recommended to review the **Swagger** documentation that can be found at the following endpoint of your deployed APIs `https://{domain name}/docs` for more information about the parameters and options for each API. It is also possible to try out each API from this link.

<!-- --8<-- [end:swagger] -->

<center> ![rest](images/redoc-logo.png){width=50%} </center>

Additionally, further information about each API can be found in Redoc format at the following endpoint of your deployed APIs `https://{domain name}/redoc`
<!-- --8<-- [start:redoc] -->

Additionally, further information about each API can be found in Redoc format at the following endpoint of your deployed APIs `https://{domain name}/redoc`

<!-- --8<-- [end:redoc] -->
Loading