Ijenko

IoE² IoT API - to create end-user applications

IoE² IoT API - to create end-user applications endpoints from Ijenko

IoT & devices#openapi#iot

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

IoE² IoT API - to create end-user applications endpoints from Ijenko

Endpoints 67

Entry points

  • GETInformation about the User/meGet information on the authenticated *User* who does the request. The *login* property is returned only if the *User* is the administrator of the *Account*.
  • PATCHUpdate User information/meUpdate *User* information (locale).
  • GETList accessible Places/places?embed-metadata=stringList the *Places* to which the *Token* has access.

Authentication

  • POSTGet a token using login+password/auth/loginGet an access+refresh tokens pair from login and password information. The *access token* obtained with this request can then be used in an Access-Token HTTP…
  • POSTRefresh a token/auth/refreshGet a new *access token* using a valid *refresh token*. This is a replacement of the *access token*: if an existing *access token* was still not expired, it…
  • POSTAsk for a new password/auth/reset-passwordTrigger the request of a new password. The account administrator will receive an e-mail with an URL pointing to a form to allow him/her to enter a new…
  • POSTRevoke a token/auth/revokeInvalidate the authentication used for the request. The access token and the refresh token will be invalid after this request. This request is typically…

Account

  • POSTChange the password/account/change-passwordSet a new password for the account. Note: requires full access to the *Account*.
  • GETList Places of the Account/account/placesList the *Places* of the account. Note: requires full access to the *Account*.
  • POSTCreate a Place/account/placesCreate a new *Place*. A *Device* (class: MINT, address: 0) is automatically created and attached to the new *Place*. Note: requires full access to the…
  • GETList active Tokens of the Account/account/tokensList the active *Tokens* on the account. Note: requires full access to the *Account*.
  • DELETERevoke a Token/account/tokens/:tokenIdRevoke the given *Token*. Note: requires full access to the *Account*.
  • GETList Users of the Account/account/users?embed-metadata=stringGet the list of *Users* of this *Account*.
  • POSTNew User/account/usersAdd a *User*. Note: requires full access to the *Account*.
  • GETInformation about a User/account/users/:userIdGet information about a *User* in the same *Account*.
  • DELETEDelete a User/account/users/:userIdDelete a *User* from this *Account*, and revoke all his/her *Tokens*. Note: requires full access to the *Account*.
  • PATCHModify a User/account/users/:userIdModify a *User*. Note: requires full access to the *Account*.
  • GETList metadata/account/users/:userId/metadataGet the metadata.
  • PATCHModify metadata/account/users/:userId/metadataModify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Place

  • GETInformation about a Place/places/:placeIdGet information about a *Place*.
  • PATCHUpdate a Place/places/:placeIdChange information about a *Place*. Note: requires full access to the *Account*.
  • GETList Buses/places/:placeId/buses?withPairing=falseGet the list of *Buses* available on the gateway of this *Place*. If withPairing is true, return only buses that allow device pairing (see…
  • GETState of the pairing window/places/:placeId/buses/:busId/pairingGet the state of the pairing window of the *Bus*. Note: requires full access to the *Account*.
  • PUTOpen/Close the pairing window/places/:placeId/buses/:busId/pairingOpen/Close the pairing window. Note: requires full access to the *Account*.
  • GETList metadata/places/:placeId/metadataGet the metadata.
  • PATCHModify metadata/places/:placeId/metadataModify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.

Device

  • GETInformation about a Device/devices/:deviceIdGet information about a *Device*.
  • PATCHUpdate a Device/devices/:deviceIdModify information about a *Device*: its name.
  • POSTAdd dynamically a functionality/devices/:deviceId/functionalitiesAdd a *Functionality* to the device. Required parameters are : functionality class endpoint Each device class has its own restrictions on which Functionality…
  • GETList metadata/devices/:deviceId/metadataGet the metadata.
  • PATCHModify metadata/devices/:deviceId/metadataModify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.
  • GETList tags/devices/:deviceId/tagsGet the tags of a *Device*.
  • PATCHModify tags/devices/:deviceId/tagsModify the tags of a *Device*.
  • GETList of Devices/places/:placeId/devices?devices=string&embed-metadata=stringGet the list of *Devices* available in this *Place*.

Functionality

  • GETInformation about a Functionality/functionalities/:functionalityIdGet the *Functionality*.
  • PATCHModify a Functionality/functionalities/:functionalityIdModify information about a *Functionality*: its name.
  • GETGet history of multiple attributes/functionalities/:functionalityId/attributes?names=string&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&surround=trueGet the values of multiple *Attributes* and their history. If the names parameter is not given, all the attributes of the *Functionality* are returned. As the…
  • GETGet an Attribute value/functionalities/:functionalityId/attributes/:attributeNameGet the *Attribute* value and the last time when it changed.
  • PUTModify an Attribute value/functionalities/:functionalityId/attributes/:attributeNameModify the value of the *Attribute*.
  • GETList metadata/functionalities/:functionalityId/metadataGet the metadata.
  • PATCHModify metadata/functionalities/:functionalityId/metadataModify the metadata. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON value.
  • GETList tags/functionalities/:functionalityId/tagsGet the tags of a *Functionality*.
  • PATCHModify tags/functionalities/:functionalityId/tagsModify the tags of a *Functionality*.
  • GETList Functionalities/places/:placeId/functionalities?devices=string&functionalities=string&embed-metadata=stringGet the list of *Functionalities* available in this *Place*.

Action

  • POSTRun actions/devices/:deviceId/run/:action?functionalities=stringRun an *Action* on zero, one or multiple Functionalities selected with tags.
  • POSTRun an action/functionalities/:functionalityId/run/:actionRun an action on the Functionality.
  • POSTRun actions/places/:placeId/run/:action?devices=string&functionalities=stringRun an *Action* on zero, one or multiple *Functionalities* selected with tags. *Device* and *Functionality* selection are combined with « AND ». If no…

Program

  • GETList Programs/places/:placeId/programs?embed-metadata=stringGet the list of *Programs* available in this *Place*.
  • POSTCreate a Program/places/:placeId/programsCreate a new *Program*. Note: requires full access to the *Account*.
  • GETInformation about a Program/programs/:programIdGet information about a *Program*.
  • DELETEDelete a Program/programs/:programIdDelete a *Program*. Note: requires full access to the *Account*.
  • PATCHModify a Program/programs/:programIdModify a *Program*: name status (enabled/disabled) code Note: requires full access to the *Account*.
  • GETHistory of executions of a Program/programs/:programId/log?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZGet the execution history list of this *Program*.
  • GETList metadata/programs/:programId/metadataGet the metadata of the *Program*.
  • PATCHModify metadata of a Program/programs/:programId/metadataModify the metadata of a *Program*. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any JSON…
  • POSTRun the Program/programs/:programId/runLaunch the *Program*. The result will be available later in the run history.

Notification

  • GETInformation about a Notification/notifications/:notificationIdGet information about a *Notification*.
  • DELETEDelete a Notification/notifications/:notificationIdDelete a *Notification*.
  • PATCHModify a Notification/notifications/:notificationIdModify a *Notification*.
  • GETList metadata/notifications/:notificationId/metadataGet the metadata of the *Notification*.
  • PATCHModify metadata of a Notification/notifications/:notificationId/metadataModify the metadata of a *Notification*. Keys are limited to the same format as tags (up to 21 characters, [a-z0-9], starting with [a-z]). Values can be any…
  • GETList Notifications/places/:placeId/notifications?embed-metadata=stringGet the list of *Notifications* available in this *Place*.
  • POSTCreate a Notification/places/:placeId/notificationsCreate a new *Notification*.

Electricity

  • GETGet autonomy rate of the place/places/:placeId/electricity/autonomy?when=2024-01-01T00:00:00Z&span=HCompute the autonomy rate of the *Place* on a time period. autonomy = 1 - (elec_drawn / elec_total_usage)
  • GETGet electricity virtual flows/places/:placeId/electricity/flows?flows=battery_chargeGet the mapping of virtual electricity flows to functionalities. Some rules are applied to expand the virtual flows using the concrete flows available. The…
  • GETGet electricity flows setup/places/:placeId/electricity/flows/setupGet the mapping of functionalities to electricity flows. A functionality is attached to *at most* one flow.
  • GETGet self-consumption rate of the place/places/:placeId/electricity/self-consumption?when=2024-01-01T00:00:00Z&span=HCompute the self-consumption rate of the *Place* on a time period. selfConsumption = 1 - (elec_feed_in / elec_total_usage)

API details

Base URL
https://ioe2api.ijenko.net
Authentication
An API key in the Access-Token header
An API key in the token query parameter
Operations
67 operations on 43 pathsGET 32PATCH 15POST 14DELETE 4PUT 2
Main resources
Account 12Functionality 11Program 9Device 8Notification 7Place 7Authentication 4Electricity 4Entry points 4Action 3
Response formats
application/json
Description format
Swagger 2.0, API version 3.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the IoE² IoT API - to create end-user applications in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the IoE² IoT API - to create end-user applications collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Access-Token header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Information about the User” (GET /me), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the IoE² IoT API - to create end-user applications?

IoE² IoT API - to create end-user applications endpoints from Ijenko It is listed under IoT & devices and has 67 endpoints.

Who publishes the IoE² IoT API - to create end-user applications?

It is listed from Ijenko's public API description (an OpenAPI document), not published by Ijenko on Swastik Codes. Anyone who controls ijenko.net can claim the profile by adding a DNS TXT record.

What is the base URL of the IoE² IoT API - to create end-user applications?

Requests go to https://ioe2api.ijenko.net. Endpoint paths are added to this base URL.

How do I authenticate with the IoE² IoT API - to create end-user applications?

It accepts 2 methods: an API key in the Access-Token header; an API key in the token query parameter.

How many endpoints does the IoE² IoT API - to create end-user applications have?

67 operations on 43 paths (32 GET, 15 PATCH, 14 POST, 4 DELETE, 2 PUT). The largest groups are Account, Functionality, Program, Device.

Is forking the IoE² IoT API - to create end-user applications free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.