Skip to content

authentic.network API documentation v2.4.0

Documentation for the REST api access of authentic.api

Common

API Information

Back to top

Provides information about the running service. The endpoint displays the version and some build informations of the implementation. The method can be used as a ping method to check if the API is accessible.

GET /api/v2

Headers - Header

Name Type Description
content-type String

Request content type, musst set to application/json

Success response example

Success response example - Success-Response:

{
  "service": "Api-Facade-Service",
  "timestamp": "2020-06-23T05:00:44.575Z",
  "environment": "integration",
  "build": {
    "time": "20-06-22 17:03",
    "branch": "master",
    "hash": "fdaa5fef"
  },
  "version": "2.0.0"
}

Check Phone Support

Back to top

The endpoint checks if the phone is supported. For this purpose, as much device information as possible must be provided.

POST /api/v2/checkPhoneSupport

Headers - Header

Name Type Description
content-type String

Request content type

Parameters examples

json - Request-Example:

{
  "os": "ios",
  "deviceInfo": {
    "identifierForVendor": "00000000-1111-2222-3333-4C1324444A44",
    "isPhysicalDevice": true,
    "localizedModel": "iPhone",
    "model": "iPhone",
    "name": "iPhone von XY",
    "systemName": "iOS",
    "systemVersion": "13.3.1",
    "utsname": {
      "machine": "iPhone9,3",
      "nodename": "iPhone-von-XY",
      "release": "19.3.0",
      "sysname": "Darwin",
      "version": "Darwin Kernel Version 19.3.0: Thu Jan  9 21:10:55 PST 2020; root:xnu-6153.82.3~1/RELEASE_ARM64_T8010
    }
  }
}

Success response example

Success response example - Success-Response:

{ "supported": true }

Error response

Error response - Errors

Name Type Description
500

Internal server error - A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.