api-client-js

Hera_API_for_application_

Usage no npm install needed!

<script type="module">
  import apiClientJs from 'https://cdn.skypack.dev/api-client-js';
</script>

README

api-client-js

ApiClientJs - JavaScript client for api-client-js Hera API for application. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api-client-js --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your api-client-js from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApiClientJs = require('api-client-js');

var defaultClient = ApiClientJs.ApiClient.instance;
// Configure Bearer access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new ApiClientJs.AdministratorProfileApi()
api.getProfile().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


Documentation for API Endpoints

All URIs are relative to https://api.hera-app.fr/backoffice/v1

Class Method HTTP request Description
ApiClientJs.AdministratorProfileApi getProfile GET /profile Returns an administrator profile
ApiClientJs.AdministratorProfileApi updateProfile PUT /profile Update an administrator profile
ApiClientJs.AdministratorsApi listAdministrators GET /administrators List application administrators
ApiClientJs.AdministratorsApi showAdministrator GET /administrators/{id} Show an administrator
ApiClientJs.AlertsApi alertsIdPut PUT /alerts/{id} Update alert status to resolved or unresolved
ApiClientJs.AlertsApi getAlerts GET /alerts Returns all the alerts that occurred before your connection
ApiClientJs.AuthenticationApi loginAdministrator POST /login Login for administrator
ApiClientJs.AuthenticationApi logoutUser POST /logout Disconnect an user
ApiClientJs.BeaconsApi createBeacon POST /beacons Add a new beacon in your company
ApiClientJs.BeaconsApi getBeacon GET /beacons/{id} Get information of a beacon
ApiClientJs.BeaconsApi getBeacons GET /beacons Returns all beacons of your current company
ApiClientJs.BeaconsApi updateBeacon PUT /beacons/{id} Update a beacon
ApiClientJs.ChatbotApi getChatbot GET /chatbot_tree Gets the chatbot questions/responses tree
ApiClientJs.ChatbotApi updateChatbot PUT /chatbot_tree Updates the chatbot questions/responses tree
ApiClientJs.CompaniesApi createCompany POST /companies Create a company
ApiClientJs.CompaniesApi getCompanies GET /companies List all companies
ApiClientJs.CompaniesApi getCompany GET /companies/{id} Get a company
ApiClientJs.CompaniesApi updateCompany PUT /companies/{id} Updates a company
ApiClientJs.MapApi getMap GET /map Gets the company's map contents
ApiClientJs.MapApi updateMap PUT /map Updates the map image
ApiClientJs.RegistrationApi adminRegister POST /register Administrator registration register
ApiClientJs.RegistrationApi registerConfirmation POST /register/{uuid}/confirmation Administrator confirmation about his identity
ApiClientJs.RegistrationApi verifUUID GET /register/{uuid} Say if uuid is a correct uuid
ApiClientJs.RolesApi createRole POST /roles Create an application role
ApiClientJs.RolesApi deleteAdministratorRole DELETE /administrators/{administrator_id}/roles/{id} Delete a role on a administrator
ApiClientJs.RolesApi getAdministratorRole GET /administrators/{administrator_id}/roles Get role of an administrator
ApiClientJs.RolesApi getRole GET /roles/{id} Get an application role
ApiClientJs.RolesApi listRoles GET /roles List application roles
ApiClientJs.RolesApi updateAdministratorRole PUT /administrators/{administrator_id}/roles/{id} Add an administrator to a role
ApiClientJs.RolesApi updateRole PUT /roles/{id} Update an application role
ApiClientJs.UsersApi listUsers GET /users List application users
ApiClientJs.UsersApi showUser GET /user/{id} Show a user

Documentation for Models

Documentation for Authorization

BearerAuth

  • Type: Bearer authentication