Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/erply-v1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: '### Configuration API with a tree-like hierarchy.'
title: CAFA V1 API
contact:
email: david.zingerman@erply.com
version: 4.19.2
tags:
- name: v1
paths:
/configuration:
get:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
description: 'All those parameters work like filters. You can search for all configs by type or by level. Or get all configs of Pos 1.
With `Look-Deeper` header set to `true` you will get the following logic of the request:
When you request a config at a User or Warehouse levels, if it is not there it will check Company level as well. When you request a config at a POS level, if it is not there it will check Warehouse (if request to ERPLY API was ok to get the Warehouse ID) and Company levels as well.'
tags:
- v1
summary: Get all configurations or a sub-list
parameters:
- description: UNIX timestamp used for the HMAC Auth method only
name: timestamp
in: header
schema:
type: string
- description: look for configuration on deeper levels. if CAFA does not find any configuration with the query parameters, CAFA will use the level_id(PointOfSaleID), to find which Warehouse the Pos belongs to and check for configuration with the same name(and type if present)
name: Look-Deeper
in: header
schema:
type: boolean
- description: Application name that uses CAFA to store configs
name: application
in: query
schema:
type: string
- description: Level is the operating level where the config is stored
name: level
in: query
schema:
type: string
enum:
- Company
- Warehouse
- Pos
- User
- Device
- description: LevelID is a unique value, used to identify the instance of the level. for User level, user id, for Pos - Point of Sale ID. Warehouse can use any unique string to identify the instance of its level, `Company level does not need level_id.`
name: level_id
in: query
schema:
type: string
- description: Type is an optional grouping property, in this case its 'payment', indicating that this configuration belongs to payment integrations group used to query groups of related configurations
name: type
in: query
schema:
type: string
- description: Name of the configuration
name: name
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/configuration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
operationId: getConfiguration
x-operation-id-source: derived
put:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
description: '`level`, `level_id` and `type` are optional fields.'
tags:
- v1
summary: Update `value` only
deprecated: true
parameters:
- description: UNIX timestamp used for the HMAC Auth method only
name: timestamp
in: header
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/configurationRequest'
description: ConfigurationDbRecord
required: true
operationId: putConfiguration
x-operation-id-source: derived
post:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
description: '`NB`: You cannot have 2 configurations with the same level,level_id, type, name and application
level, level_id and type are optional fields.'
tags:
- v1
summary: Save
deprecated: true
parameters:
- description: UNIX timestamp used for the HMAC Auth method only
name: timestamp
in: header
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/configurationRequest'
description: ConfigurationDbRecord
required: true
operationId: postConfiguration
x-operation-id-source: derived
delete:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
description: 'Delete will delete the configuration by strict match of the following fields: level, application, levelID, type and name.'
tags:
- v1
summary: Delete
deprecated: true
parameters:
- description: UNIX timestamp used for the HMAC Auth method only
name: timestamp
in: header
schema:
type: string
- description: Application (s) name that uses CAFA to store configs
name: application
in: query
required: true
schema:
type: string
- description: Level is the operating level where the config is stored. Has to be one of Company, Warehouse, Pos, User
name: level
in: query
schema:
type: string
- description: LevelID is an unique value, used to identify the instance of the level. for User level, user id, for Pos - Point of Sale ID. Warehouse can use any unique string to identify the instance of its level, Company level does not need level_id.
name: level_id
in: query
schema:
type: string
- description: Type is an optional grouping property, in this case its 'payment', indicating that this configuration belongs to payment integrations group used to query groups of related configurations
name: type
in: query
schema:
type: string
- description: Name of the configuration
name: name
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
operationId: deleteConfiguration
x-operation-id-source: derived
/configuration/apps:
get:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
description: Get a list of all application names that the user has configurations for.
tags:
- v1
summary: Get a list of all application names that the user has configurations for
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/appsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
operationId: getConfigurationApps
x-operation-id-source: derived
/configuration/{applicationName}:
get:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
description: The endpoint allows you to get all the configurations in an application
tags:
- v1
summary: Get all configurations for an application
parameters:
- description: UNIX timestamp used for the HMAC Auth method only
name: timestamp
in: header
schema:
type: string
- description: Application name
name: applicationName
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/configuration'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
operationId: getConfigurationByApplicationName
x-operation-id-source: derived
/configuration/{id}/move:
put:
security:
- sk: []
- cc: []
- hmac-auth: []
- jwt: []
tags:
- v1
summary: Moving means changing the level_id
parameters:
- description: UNIX timestamp used for the HMAC Auth method only
name: timestamp
in: header
schema:
type: string
- description: ConfigurationDbRecord ID
name: id
in: path
required: true
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/response'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/response'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/moveRequest'
description: desired levelID
required: true
operationId: putConfigurationByIdMove
x-operation-id-source: derived
components:
schemas:
response:
type: object
properties:
id:
type: integer
message:
type: string
statusCode:
type: string
configuration:
type: object
properties:
added:
type: integer
addedby_id:
type: integer
application:
type: string
example: erply-to-woo-sync
changed:
type: integer
changedby_id:
type: integer
id:
type: string
level:
description: Level is optional
type: string
example: Pos
level_id:
description: LevelID is optional
type: string
example: '1'
name:
type: string
example: adyen
type:
description: Type is optional
type: string
example: payment
value: {}
moveRequest:
type: object
properties:
level_id:
description: LevelID is new level_id to set for the config
type: string
configurationRequest:
type: object
properties:
application:
description: Application (s) name that uses CAFA to store configs, application name has to be generated manually before it can be used in Identity Admin.
type: string
example: woo-comm
level:
description: Level is the operating level where the config will be stored. Has to be one of Company, Warehouse, Pos, User
type: string
example: Pos
level_id:
description: 'LevelID is a unique value, used to identify the instance of the level.
for User level, user id
for Pos - Point of Sale ID. Each Pos belongs to Warehouse. When we query CAFA for configuration on level: ''Pos'', and add ''Look-Deeper: true'' header, if CAFA dooes not find any configuration with the query parameters, CAFA will use the level_id(PointOfSaleID), to find which Warehouse the Pos belongs to and check for configuration with the same name(and type if present)
Warehouse can use any unique string to identify the instance of its level, because the higher level for each Warehouse is Company level, which can only be one instance per account
Company level does not need level_id because there can only be one company per account in Erply.'
type: string
example: '1'
name:
description: Name of the configuration
type: string
example: adyen
type:
description: 'Type is an optional grouping property, in this case its ''payment'',
indicating that this configuration belongs to payment integrations group
used to query groups of related configurations'
type: string
example: payment
value:
description: 'Value stored by the configuration. Supported types: JSON, JSON array, string'
appsResponse:
type: object
properties:
applications:
type: array
items:
type: string
securitySchemes:
cc:
type: apiKey
name: clientCode
in: header
hmac-auth:
type: apiKey
name: hmac-auth
in: header
jwt:
type: apiKey
name: jwt
in: header
sk:
type: apiKey
name: sessionKey
in: header