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

Erply device API

The device API from Erply — 4 operation(s) for device.

Erply device API is one of 64 APIs that Erply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include device. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 2.0, at version 2.36.5.

Requests are made against the base URL https://api-pim-eu.erply.com.

6 operations 4 paths 3 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.36.5
Base URL
https://api-pim-eu.erply.com
Authentication
API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Erply device API declares 5 security schemes for authenticating requests. An API key is passed in the header as accessToken (AccessToken). An API key is passed in the header as clientCode (ErplyClientCode). An API key is passed in the header as jwt (ErplyJWT). An API key is passed in the header as sessionKey (ErplySession). An API key is passed in the header as requestKey (RequestKey).

Paths & Operations 6

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

device 6
GET
/api/v1/device
Look up devices
18 params → 200401500
POST
/api/v1/device
Add a new device record
1 param → 201400401500
GET
/api/v1/device-global
Search for devices across all accessible tenants
10 params → 200401500
DELETE
/api/v1/device/{deviceId}
Delete one device record
1 param → 200400401404500
PATCH
/api/v1/device/{deviceId}
Update device record
2 params → 200400401404500
GET
/api/v1/device/{deviceId}/log
Retrieve device record related logged values
8 params → 200401404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DeviceResponse (25 properties), DeviceRequest (19 properties), DeviceLogResponse (10 properties). Each schema is shown below with its type and property counts.

DeviceRequest
object
19 properties
DeviceResponse
object
25 properties
DeviceLogResponse
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-device-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
Erply Assortment To Product Linking API
Erply Attributes API
Erply auth API
Erply Brand API
Erply clsf API
Erply clsf-device-properties API
Erply clsf-events API
Erply clsf-labels API
Erply Country API
Erply event API
Erply Export API