Creates an app integration authentication with import file settings

Creates a new app integration authentication with import file setting.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

multipart/form-data

AppIntegrationIdstringRequired

The id of the app integration to import.

Filestring · binaryRequired

The file setting to import.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

409

The brand had already been configured with app integration authentication.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/app-integrations/authentication/import

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/authentication/import HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 603

{
  "appIntegrationId": "sApKpllz4sAplsmzha",
  "code": "GOOGLE_OAUTH2",
  "name": "Google OAuth2 Integration",
  "projectId": "my-google-project-123",
  "clientId": "1234567890-abc.apps.googleusercontent.com",
  "clientSecret": "GOCSPX-EXAMPLESECRET",
  "redirectURI": "https://subdomain.com/auth/callback",
  "scope": "openid email profile",
  "authEndpoint": "https://accounts.google.com/o/oauth2/auth",
  "tokenEndpoint": "https://oauth2.googleapis.com/token",
  "iconURL": "https://subdomain.com/assets/google-icon.png",
  "tags": "#google #oauth2",
  "description": "Integration for Google OAuth2 authentication.",
  "status": "Active",
  "isDefault": true
}

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "isDefault": false,
    "status": "Active",
    "description": "description",
    "tags": "tags",
    "iconURL": "iconUrl",
    "tokenEndpoint": "tokenEndpoint",
    "id": "sApKpllz4sAplsmzha",
    "authEndpoint": "authEndpoint",
    "redirectURI": "redirectUri",
    "clientSecret": "clientSecret",
    "clientId": "clientId",
    "projectId": "projectId",
    "name": "name",
    "code": "code",
    "scope": "scope"
  },
  "errors": []
}