Push Server Administration

Edit on Github Send Feedback 2021.03 - Current Release

PowerAuth Push Server can be administered using a RESTful API.

The RESTful API is documented in a dedicated chapter.

Administration using Insomnia

Insomnia is an easy to use RESTful API client. You can get Insomnia from https://insomnia.rest

To import the Push Server workspace into Insomnia, create a workspace using menu in the top left corner. Use the Create Workspace option and then click Import/Export. You can import the workspace with all requests from provided workspace export file.

All requests which are described below are already prepared in the provided Insomnia worskpace, so you can easily update the JSON requests and execute them.

Administration using cURL

Curl is a command line HTTP client. You can get cURL from https://curl.haxx.se

Retrieve Application List

curl --request GET \
  --url http://localhost:8080/powerauth-push-server/admin/app/list

Retrieve Unconfigured Application List

curl --request GET \
  --url http://localhost:8080/powerauth-push-server/admin/app/unconfigured/list

Create an Application

curl --request POST \
  --url http://localhost:8080/powerauth-push-server/admin/app/create \
  --header 'content-type: application/json' \
  --data '{
  "requestObject": {
    "appId": 1
  }
}'

Update the appId value with requested PowerAuth application ID. The value id from response object will be used for identification of the Push Server application.

Get Application Detail

curl --request POST \
  --url http://localhost:8080/powerauth-push-server/admin/app/detail \
  --header 'content-type: application/json' \
  --data '{
  "requestObject": {
    "id": 1,
    "includeIos": true,
    "includeAndroid": true
  }
}'

Update the id value with requested Push Server application ID.

Update APNs Configuration

curl --request POST \
  --url http://localhost:8080/powerauth-push-server/admin/app/ios/update \
  --header 'content-type: application/json' \
  --data '{
  "requestObject": {
    "id": 1,
    "bundle": "com.wultra.myApp",
    "keyId": "keyId",
    "teamId": "teamId",
    "privateKeyBase64": "a2V5"
  }
}'

Set the id value for Push Server application ID to want to update.

Enter the base64-encoded value of APNs private key into privateKeyBase64.

You can encode the file using base64 command on Mac. You can also use Certutil.exe on Windows or OpenSSL on all platforms.

base64 -i <in-file> -o <outfile>

Remove APNs Configuration

curl --request DELETE \
  --url http://localhost:8080/powerauth-push-server/admin/app/ios/remove \
  --cookie JSESSIONID=76D3CE8C7F92E1FC090A79886E43B235 \
  --data '{
  "requestObject": {
    "id": 1
  }
}'

Set the id value for the Push Server application ID you want to update.

Update FCM Configuration

curl --request POST \
  --url http://localhost:8080/powerauth-push-server/admin/app/android/update \
  --header 'content-type: application/json' \
  --data '{
  "requestObject": {
    "id": 1,
    "projectId": "projectId",
    "privateKeyBase64": "a2V5"
  }
}'

Set the id value for Push Server application ID to want to update.

Enter the base64-encoded value of FCM private key into privateKeyBase64.

You can encode the file using base64 command on Mac. You can also use Certutil.exe on Windows or OpenSSL on all platforms.

base64 -i <in-file> -o <outfile>

Remove FCM Configuration

curl --request DELETE \
  --url http://localhost:8080/powerauth-push-server/admin/app/android/remove \
  --header 'content-type: application/json' \
  --data '{
  "requestObject": {
    "id": 1
  }
}'

Set the id value for the Push Server application ID you want to update.

Administration using SQL Database

Push server can be also administered by updating the push_app_credentials table.

See the PowerAuth Push Server Database Structure for more details.

Last updated on Mar 23, 2021 (20:33) Edit on Github Send Feedback
Search

2020.11

Mobile token

Powerauth push server