Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

1NCE Optimizer API

Optimize energy consumption

1NCE Optimizer API is one of 22 APIs that 1NCE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Optimizer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version v2.1.1.

Requests are made against a single base URL, https://api.1nce.com/management-api.

6 operations 4 paths 18 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2.1.1
Server
https://api.1nce.com/management-api
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

1NCE Optimizer API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication).

  • BasicAuthentication — Basic authentication used for obtaining the Bearer Authentication Token. The Bearer Token can then be used to make any further API calls towards the 1NCE API.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Optimizer 6

Optimize energy consumption

POST
/v1/optimize/messages/test
Test template
body → 200400401403500
GET
/v1/optimize/savings
Get savings
3 params → 200400401403500
GET
/v1/optimize/templates
Get Optimizer Templates
→ 200403500
POST
/v1/optimize/templates
Create Optimizer Template
body → 201403409422500
DELETE
/v1/optimize/templates/{templateId}
Delete Optimizer Template
1 param → 204403404500
PATCH
/v1/optimize/templates/{templateId}
Update Optimizer Template
1 param body → 200403404409422500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are postPatchTranslationTemplatesResponseschema (5 properties), getTranslationTemplatesResponseschema_inner (5 properties), createTranslationTemplateRequestschema (4 properties), patchTranslationTemplateRequestschema (4 properties). Each schema is shown below with its type and property counts.

getResponseschema_3_messagesTranslated
object
Statistics about the number of messages translated.
2 properties 2 required
createTranslationTemplateRequestschema
object
Post new Translation Template model.
4 properties 3 required
unauthorizedRequestResponse
object
An API error response in case of an HTTP Unauthorized Request.
3 properties
notFoundResponse
object
An API error response when a resource is Not Found.
3 properties
getTranslationTemplatesResponseschema_inner
object
5 properties 5 required
patchTranslationTemplateRequestschema
object
Update a Translation Template.
4 properties
postschema_4
object
Test a translation template with a sample input message request.
2 properties 2 required
postResponseschema_1
object
Response to the test a translation template with a sample input message request.
3 properties 3 required
conflictResponse
object
An API error response when a conflict is found.
3 properties
getResponseschema_3_bytesSaved
object
Statistics about the bytes reduced by using the translation templates.
2 properties 2 required
getResponseschema_3_averageBytesReducedPerMessage
object
Statistics about the average amount of bytes reduced per translated message.
2 properties 2 required
getTranslationTemplatesResponseschema
array
Response to the get Translation Template request.
postPatchTranslationTemplatesResponseschema
object
Response to the post or the patch Translation Template request.
5 properties 5 required
getResponseschema_3
object
Response to the get optimizer savings request.
3 properties 3 required
serverErrorResponse
object
An API error response in case of a Server Side Error.
2 properties
unprocessableEntityResponse
object
An API error response when the request is valid but cannot be processed.
3 properties
badRequestResponse
object
An API error response in case of an HTTP Bad Request.
3 properties
forbiddenResponse
object
An API error response in case of an HTTP Forbidden Request.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1nce-optimizer-api-openapi.yml Raw ↑

Other APIs 1NCE publishes across the network.

1NCE Administration Logs API
1NCE Agreements API
1NCE Bearer Authorization API
1NCE Connectivity API
1NCE Device Inspector API
1NCE Device Locator API
1NCE Devices API
1NCE General SIMs API
1NCE IoT Integrator API
1NCE Orders API
1NCE Plugin system API
1NCE Products API