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

ERPNext Naive Authentication API

If you are developing something serious, you may want to use oAuth2.

ERPNext Naive Authentication API is one of 3 APIs that ERPNext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Naive Authentication. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths. 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.

3 operations 3 paths 0 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.0.1
Base URL
https://{your-erpnext-instance}/api
Authentication
API Key, HTTP Basic, OAuth 2.0
License
GPL-3.0
Resource Areas
1

Authentication & Security 3

ERPNext Naive Authentication 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 3

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

Naive Authentication 3

If you are developing something serious, you may want to use oAuth2.

POST
/method/login
Authenticate yourself
login 2 params body → 200401
GET
/method/logout
Logout from current session
→ 200
GET
/method/frappe.auth.get_logged_user
Get the user that is logged in
authGetLoggedUser → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erpnext-naive-authentication-api-openapi.yml Raw ↑

Other APIs ERPNext publishes across the network.

ERPNext Method API
ERPNext Resource API