Script Development / API Authentication

For HTTP APIs generated by "Function APIs", additional interface authentication can be added.

Currently supported interface authentication methods are as follows:

Authentication Type	Description
Fixed Field	Validates that the request's Header, Query, or Body must contain a field with a specific value
HTTP Basic	Standard HTTP Basic authentication (a login dialog pops up when accessed in a browser)
HTTP Digest	Standard HTTP Digest authentication (a login dialog pops up when accessed in a browser)
Authentication Function	Specifies a self-written function as the authentication function

Users can add authentication configurations in "Manage / API Authentication", and then specify the added authentication configuration in "Function API Configuration".

If high security requirements exist, be sure to access the interface using HTTPS

1. Fixed Field Authentication

Fixed field authentication is the simplest authentication method. It requires the client and DataFlux Func to agree on including a specific field and its value somewhere in the request (Header, Query, or Body). This content is attached with each call to complete authentication.

Assuming it is agreed that each request header must contain x-auth-token="my-auth-token", then calling in the following way will complete authentication:

GET /api/v1/al/func-api-xxxxx
x-auth-token: my-auth-token

When configuring multiple fixed field authentications, a match on any one is considered as passing authentication

For fields used for authentication in Query and Body, the system will automatically delete them after successful authentication and will not pass them to the function

2. HTTP Basic / HTTP Digest

Authentication methods directly supported by browsers.

When accessing an interface using this authentication method directly from the browser address bar, the browser will pop up a username/password box for the user to fill in.

If programmatic access is needed, please refer to the following code:

import requests
from requests.auth import HTTPBasicAuth, HTTPDigestAuth

# HTTP Basic authentication
resp = requests.get(url_1, auth=HTTPBasicAuth('user', 'password'))

# HTTP Digest authentication
resp = requests.get(url_2, auth=HTTPDigestAuth('user', 'password'))

3. Authentication Function

If the interface authentication method is complex or special (e.g., needs to integrate with business systems, etc.), you can choose to write your own function for authentication.

The function used for authentication does not require parameters. Returning True indicates successful authentication, while returning other content or throwing an error indicates failure.

Within the authentication function, you can use the built-in variable _DFF_HTTP_REQUEST to obtain request-related information: Script Development / Built-in Variables / _DFF_HTTP_REQUEST

@DFF.API('Authentication Function')
def my_auth_func():
    return _DFF_HTTP_REQUEST['headers']['x-auth-token'] == 'my-auth-token'

It should be noted that when authentication fails, the interface's return format will also differ depending on the returned content:

Return FalseReturn StringReturn JSONThrow Error

@DFF.API('Authentication Function')
def my_auth_func():
    return False

Authentication fails. When directly returning False, the interface response body will not contain any specific error information:

{
  "ok"     : false,
  "error"  : 401.99,
  "reason" : "EAPIAuth",
  "message": "Func Auth failed",
  "detail" : false,
  "status" : 401,
  "reqDump": {
    "method": "GET",
    "url"   : "http://localdev:8089/api/v1/func-api/xxxxx/s"
  },
  "traceId"   : "TRACE-XXXXX",
  "clientTime": null,
  "reqTime"   : "2025-08-14T11:03:45.238Z",
  "respTime"  : "2025-08-14T11:03:45.406Z",
  "reqCost"   : 168
}

@DFF.API('Authentication Function')
def my_auth_func():
    return 'Bad User!'

Authentication fails. When returning a string, this string will be returned as the detail field:

{
  "ok"     : false,
  "error"  : 401.99,
  "reason" : "EAPIAuth",
  "message": "Func Auth failed",
  "detail" : "Bad User!",
  "status" : 401,
  "reqDump": {
    "method": "GET",
    "url"   : "http://localdev:8089/api/v1/func-api/xxxxx/s"
  },
  "traceId"   : "TRACE-XXXXX",
  "clientTime": null,
  "reqTime"   : "2025-08-14T11:03:45.238Z",
  "respTime"  : "2025-08-14T11:03:45.406Z",
  "reqCost"   : 168
}

@DFF.API('Authentication Function')
def my_auth_func():
    return { 'error': 'Bad User!' }

Authentication fails. When returning JSON, this JSON will be returned as the detail field:

{
  "ok"     : false,
  "error"  : 401.99,
  "reason" : "EAPIAuth",
  "message": "Func Auth failed",
  "detail": {
    "error": "Bad User!"
  },
  "status": 401,
  "reqDump": {
    "method": "GET",
    "url"   : "http://localdev:8089/api/v1/func-api/xxxxx/s"
  },
  "traceId"   : "TRACE-XXXXX",
  "clientTime": null,
  "reqTime"   : "2025-08-14T11:03:45.238Z",
  "respTime"  : "2025-08-14T11:03:45.406Z",
  "reqCost"   : 168
}

@DFF.API('Authentication Function')
def my_auth_func():
    raise Exception('Bad User!')

When the authentication function throws an error, since the Func framework level cannot perceive whether this Exception belongs to business logic or the code itself reporting an error, it will return generic error information as the detail field:

{
  "ok": false,
  "error": 401.99,
  "reason": "EAPIAuth",
  "message": "Func Auth failed",
  "detail": {
    "name"               : "Func.Runner",
    "id"                 : "task-RWLH3EuCRfYl",
    "triggerTime"        : 1755170213.119,
    "startTime"          : 1755170213.122,
    "endTime"            : 1755170213.13,
    "status"             : "failure",
    "exceptionType"      : "UserScriptException",
    "exception"          : "In User Script: Exception('Bad User!')",
    "exceptionFrom"      : "userScript",
    "originExceptionType": "Exception",
    "originException"    : "Exception('Bad User!')"
  },
  "status": 401,
  "reqDump": {
    "method": "GET",
    "url"   : "http://localdev:8089/api/v1/func-api/xxxxx/s"
  },
  "traceId"   : "TRACE-XXXXX",
  "clientTime": null,
  "reqTime"   : "2025-08-14T11:03:45.238Z",
  "respTime"  : "2025-08-14T11:03:45.406Z",
  "reqCost"   : 168
}