Help Center> Simple Message Notification> API Reference> APIs> Application Operations> Creating a Platform Application
View PDF

Creating a Platform Application

Function

This API is used to create a platform application.

URI

POST /v2/{project_id}/notifications/applications

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the application name.

The value can contain only letters, underscores (_), and digits and cannot exceed 64 characters.

platform

Yes

String

Specifies the application platform.

Only HMS, APNS, and APNS_SANDBOX are supported.

HMS is a platform for developers to push Android messages.

APNS and APNS_SANDBOX are platforms for pushing iOS messages.

platform_principal

Yes

String

For HMS, set it to the app ID, which contains only letters and digits and does not exceed 20 characters. For APNS and APNS_SANDBOX, set it to the platform certificate, which is encoded using Base64 and cannot exceed 8 KB.

platform_credential

Yes

String

For HMS, set it to the app secret that contains 32 to 64 characters and consists of only letters and digits.

For APNS and APNS_SANDBOX, set it to the certificate private key, which is encoded using Base64 and cannot exceed 8 KB.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

application_urn

String

Specifies the unique resource identifier of the application.

application_id

String

Specifies the application resource ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Example Requests

Creating a platform application

POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications

{
  "name" : "application_name",
  "platform" : "HMS",
  "platform_principal" : "appId",
  "platform_credential" : "appSecret"
}

Example Responses

None

Status Codes

Status Code

Description

201

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Application Operations