Skip to main content
POST
/
authentication
/
foreign
Register Foreign App (deprecated)
curl --request POST \
  --url https://api.jtl-cloud.com/erp/authentication/foreign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-challengecode: <x-challengecode>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "AppId": "<string>",
  "DisplayName": "<string>",
  "Description": "<string>",
  "Version": "<string>",
  "ProviderName": "<string>",
  "ProviderWebsite": "<string>",
  "MandatoryApiScopes": [
    "<string>"
  ],
  "AppIcon": "aSDinaTvuI8gbWludGxpZnk=",
  "LocalizedDisplayNames": [
    {
      "LanguageIso": "<string>",
      "Name": "<string>"
    }
  ],
  "LocalizedDescriptions": [
    {
      "LanguageIso": "<string>",
      "Name": "<string>"
    }
  ],
  "OptionalApiScopes": [
    "<string>"
  ],
  "Signature": "aSDinaTvuI8gbWludGxpZnk=",
  "SignatureData": "2023-11-07T05:31:56Z"
}
'
{
  "RequestStatusInfo": {
    "AppId": "<string>",
    "RegistrationRequestId": "<string>"
  },
  "Token": {
    "ApiKey": "<string>"
  },
  "GrantedScopes": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-challengecode
string
required

You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.

Body

application/json

Wird angenommen, aber nicht verarbeitet.

Model Class: CreateAppRegistrationRequest

AppId
string
required

Unique identifier of the application

DisplayName
string
required

Default display name of the application

Description
string
required

Default description of the application

Version
string
required

Version of the application to be registered

ProviderName
string
required

Name of the application's provider

ProviderWebsite
string
required

Website of the application's provider

MandatoryApiScopes
string[]
required

Mandatory required API scopes for the application to work

AppIcon
string<byte>
required

Base64 encoded data of an image.

LocalizedDisplayNames
object[]

Localized display names of the application

LocalizedDescriptions
object[]

Localized descriptions of the application

OptionalApiScopes
string[]

Optional (recommended) API scopes for the application

RegistrationType
enum<integer>

multiple instances of the application possible

Available options:
0,
1,
2,
3
Signature
string<byte>

The Signature of the App, it combines AppId.SignatureData like myApp/v1.2025-08-03T25:48:00 in UTC Time

SignatureData
string<date-time>

The Data as DateTimeOffset must be in a range from 10 Minutes equals, and is base for the Signature and must be in UTC Time

Response

201 - application/json

Neutral success response — die Anfrage wird angenommen, aber nicht ausgeführt.

Model Class: RegistrationInformation

RequestStatusInfo
object
required

Status of the registration process (including the unique identifiers for application and registration request)

Token
object

Generated token for the application to access the API

GrantedScopes
string[]

API scopes (both mandatory and optional) granted to the application