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 v1 API

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

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

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

This API exposes 7 operations across 4 paths, and defines 5 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.

7 operations 4 paths 5 schemas 1 DELETE3 GET1 POST2 PUT

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 v1 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 7

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

v1 7
GET
/configuration
Get all configurations or a sub-list.
7 params → 200400500
PUT
/configurationdeprecated
Update value only
2 params → 201400500
POST
/configurationdeprecated
Save
2 params → 201400500
DELETE
/configurationdeprecated
Delete
6 params → 200400500
GET
/configuration/apps
Get a list of all application names that the user has configurations for.
→ 200400500
GET
/configuration/{applicationName}
Get all configurations for an application.
2 params → 200400500
PUT
/configuration/{id}/move
Moving means changing the levelid.
3 params → 201400500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are configuration (11 properties), configurationRequest (6 properties), response (3 properties), appsResponse (1 property). Each schema is shown below with its type and property counts.

response
object
3 properties
moveRequest
object
1 property
appsResponse
object
1 property
configurationRequest
object
6 properties
configuration
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-v1-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 device API
Erply event API