Aura API clients

Introduction

aura-bot has connections with several APIs through the use of different modules, which constitutes a practical way to communicate with them.

In this framework, API clients, or just clients, are defined as modules to be used inside the code that contain a set of tools with the purpose of carrying out requests in the simplest way.

API clients are generated automatically from the swagger file delivered by the API constructor, usually Kernel. Aura uses a custom code generator based on the OpenAPI initiative in order to generate TypeScript clients which is compatible with JavaScript.

There are two types of clients, External Clients that are associated with services external to Aura, and Internal Clients, associated with Aura servers.

All Aura API clients can be found in the following Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-clients/

Content in this section

This section contains all the information related to Aura API clients:

• Internal API clients in Aura

• External API clients in Aura

• Guidelines for the creation or update of an API client