ERPNext Resource API
The Resource API from ERPNext — 2 operation(s) for resource.
ERPNext Resource API is one of 3 APIs that ERPNext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Resource. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 0.0.1.
Requests are made against 2 base URLs: https://demo.erpnext.com/api, https://{company}.erpnext.com/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
ERPNext Resource API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (tokenAuth).
It accepts HTTP basic authentication (basicAuth).
It supports OAuth 2.0 (oAuth2) using the authorizationCode flow, exposing 1 scope.
tokenAuth— Get your API keys at User - Api Access - Generate Keys. "headers = {'Authorization': 'token : '}"basicAuth— Get your API keys at User - Api Access - Generate Keys. username = apikey; password = apisecret [More info](https://frappe.io/docs/user/en/guides/integration/t…oAuth2— This API uses OAuth 2 with the authorization code flow. [More info]https://frappe.io/docs/user/en/guides/integration/usingoauth)
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are DocType (7 properties), DocList (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ERPNext 2
Other APIs ERPNext publishes across the network.