Applications

Creates an application and a client in AuthN.

POST /operative/applications/{app_owner_id}/clients/{app_client_id}

Parameters

Name	In	Type	Required	Description
app_owner_id	path	string	true	‘none’
app_client_id	path	string	true	‘none’
body	body	OperativeCreateApplicationRequest	true	‘none’

Request body - instance of OperativeCreateApplicationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "appOwnerName": "string",
  "appOwnerEmail": "user@example.com",
  "appOwnerDescription": "string",
  "appClientSecret": "string",
  "appClientRedirectURL": [
    "http://example.com"
  ],
  "appClientName": "string",
  "appClientJwksUri": "http://example.com"
}

Name	Type	Required	Description
appOwnerName	string	true	The Aggregator Name plus the AppOwner ID.
appOwnerEmail	string(email)	false	The AppOwner’s contactMedium.emailAddress.
appOwnerDescription	string	true	Trading Name, organizationType and tax Number.
appClientSecret	string	true	Application Client Secret.
appClientRedirectURL	[string]	false	Application redirectURL.
appClientName	string	true	Application commercialName.
appClientJwksUri	string(uri)	false	Application Client jwks Uri.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16



curl -X POST https://opengateway.masstack.com/v1/operative/applications/{app_owner_id}/clients/{app_client_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'appOwnerName': 'string',
  'appOwnerEmail': 'user@example.com',
  'appOwnerDescription': 'string',
  'appClientSecret': 'string',
  'appClientRedirectURL': [
    'http://example.com'
  ],
  'appClientName': 'string',
  'appClientJwksUri': 'http://example.com'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful operation	OperativeApplicationClientResponse
400	Bad Request	Problem with the client request	OperativeApiError
401	Unauthorized	Unauthorized	OperativeApiError
403	Forbidden	Client does not have sufficient permission.	OperativeApiError
500	Internal Server Error	Server error	OperativeApiError
503	Service Unavailable	Service unavailable. Typically the server is down.	OperativeApiError
504	Gateway Time-out	Request time exceeded. If it happens repeatedly, consider reducing the request complexity	OperativeApiError

Get an application and a client by AppOwnerId and AppClientId.

Returns the information of the application and the associated client.

GET /operative/applications/{app_owner_id}/clients/{app_client_id}

Parameters

Name	In	Type	Required	Description
app_owner_id	path	string	true	‘none’
app_client_id	path	string	true	‘none’

Request example

1
2
3
4



curl -X GET https://opengateway.masstack.com/v1/operative/applications/{app_owner_id}/clients/{app_client_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful operation	OperativeApplicationClientResponse
400	Bad Request	Problem with the client request	OperativeApiError
401	Unauthorized	Unauthorized	OperativeApiError
403	Forbidden	Client does not have sufficient permission.	OperativeApiError
500	Internal Server Error	Server error	OperativeApiError
503	Service Unavailable	Service unavailable. Typically the server is down.	OperativeApiError
504	Gateway Time-out	Request time exceeded. If it happens repeatedly, consider reducing the request complexity	OperativeApiError

Create a new product order for a client to consume the Open Gateway APIs

Create a new product order by specifying the scope and purpose of the API to be consumed

POST /operative/applications/{app_owner_id}/clients/{app_client_id}/product-orders

Parameters

Name	In	Type	Required	Description
app_owner_id	path	string	true	‘none’
app_client_id	path	string	true	‘none’
body	body	OperativeCreateProductOrderRequest	true	‘none’

Request body - instance of OperativeCreateProductOrderRequest

1
2
3
4


{
  "scope": "string",
  "purpose": "string"
}

Name	Type	Required	Description
scope	string	true	Defines the scope of the API.
purpose	string	true	Defines the purpose of the API.

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://opengateway.masstack.com/v1/operative/applications/{app_owner_id}/clients/{app_client_id}/product-orders \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'scope': 'string',
  'purpose': 'string'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successful operation	None
400	Bad Request	Problem with the client request	OperativeApiError
401	Unauthorized	Unauthorized	OperativeApiError
403	Forbidden	Client does not have sufficient permission.	OperativeApiError
500	Internal Server Error	Server error	OperativeApiError
503	Service Unavailable	Service unavailable. Typically the server is down.	OperativeApiError
504	Gateway Time-out	Request time exceeded. If it happens repeatedly, consider reducing the request complexity	OperativeApiError

400 - instance of OperativeApiError

Custom schema example

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error