Skip to content

ClientConfiguration

Get Client Configurations

Endpoint:

GET api/v9/mapscale/client-configurations

Description:

Gets a list of all client configurations.

Success Response:

[
  {
    "name": "example-client",
    "pointrCloudBaseURL": "example.pointr.cloud",
    "licenseKey": "a891232c-15d9-4d70-ab61-93e0d8b4c1a2",
    "clientIdentifier": "2fdb0e27-15d9-4d70-ab61-93e0d8b4c1a2",
    "clientExternalIdentifier": "client-external",
    "dashboardURL": "https://example-dashboard.pointr.cloud",
    "engineId": "ed410099-3383-473c-b356-d57f90654bc5",
    "azureStorageConnectionString": "DefaultEndpointsProtocol=https;...",
    "apiKey": "a17de7eb-31ef-4cc6-a056-4d0f2a40de54"
  },
  {
    "name": "example-client2",
    "pointrCloudBaseURL": "example2.pointr.cloud",
    "licenseKey": "a8912341-15d9-4d70-ab61-93e0d8b4c1a2",
    "clientIdentifier": "151b0e27-15d9-4d70-ab61-93e0d8b4c1a2",
    "clientExternalIdentifier": "client2-external",
    "dashboardURL": "https://example2-dashboard.pointr.cloud",
    "engineId": "ed410099-3383-473c-b356-d57f90654bc5",
    "azureStorageConnectionString": "DefaultEndpointsProtocol=https;...",
    "apiKey": "a17de7eb-31ef-4cc6-a056-4d0f2a40de54"
  },
  {
    "name": "example-client3",
    "pointrCloudBaseURL": "example3.pointr.cloud",
    "licenseKey": "a8914211-15d9-4d70-ab61-93e0d8b4c1a2",
    "clientIdentifier": "1abe0e27-15d9-4d70-ab61-93e0d8b4c1a2",
    "clientExternalIdentifier": "client3-external",
    "dashboardURL": "https://example3-dashboard.pointr.cloud",
    "engineId": "ed410099-3383-473c-b356-d57f90654bc5",
    "azureStorageConnectionString": "DefaultEndpointsProtocol=https;...",
    "apiKey": "a17de7eb-31ef-4cc6-a056-4d0f2a40de54"
  }
]


* You can access the possible response codes you may encounter here.

Get Client Configuration

Endpoint:

GET api/v9/mapscale/client-configurations/{clientIdentifier}

Description:

Gets a specific client configuration using the clientIdentifier.

Success Response:

{
  "name": "example-client",
  "pointrCloudBaseURL": "example.pointr.cloud",
  "licenseKey": "a891232c-15d9-4d70-ab61-93e0d8b4c1a2",
  "clientIdentifier": "2fdb0e27-15d9-4d70-ab61-93e0d8b4c1a2",
  "clientExternalIdentifier": "client-external",
  "dashboardURL": "https://example-dashboard.pointr.cloud",
  "engineId": "ed410099-3383-473c-b356-d57f90654bc5",
  "azureStorageConnectionString": "DefaultEndpointsProtocol=https;...",
  "apiKey": "a17de7eb-31ef-4cc6-a056-4d0f2a40de54"
}


* You can access the possible response codes you may encounter here.

Create Client Configuration

Endpoint:

POST api/v9/mapscale/client-configurations

Description:

Creates a new client configuration.

Validations
  • Name is required.
  • PointrCloudBaseURL is required.
  • LicenseKey is required.
  • ClientIdentifier is required.
  • ClientExternalIdentifier is required.
  • DashboardUrl is required.
  • AzureStorageConnectionString is required.
  • EngineId is an optional field. You can specify if you want it to run on a specific engine. If not specified, it will work with the default engine.

Request Body:

{
  "name": "test client",
  "pointrCloudBaseURL": "https://example.pointr.cloud",
  "licenseKey": "5eca8f80-9b33-4945-b8c2-104e2983ada7",
  "clientIdentifier": "6a49fb45-97e5-468d-a8e7-4fa84520c351",
  "clientExternalIdentifier": "client-external-identifier",
  "dashboardURL": "https://example-dashboard.pointr.cloud",
  "engineId": "ed410099-3383-473c-b356-d57f90654bc5",
  "azureStorageConnectionString": "DefaultEndpointsProtocol=https;...",
  "apiKey": "a17de7eb-31ef-4cc6-a056-4d0f2a40de54"
}

Success Response: 

{
  "message": "Client Configuration is successfully created."
}


* You can access the possible response codes you may encounter here.

Update Client Configuration

Endpoint:

PUT api/v9/mapscale/client-configurations/{clientIdentifier}

Description:

Updates a client configuration.

Validations
  • ClientIdentifier given from the URL must be valid.
  • Name is required.
  • PointrCloudBaseURL is required.
  • LicenseKey is required.
  • ClientExternalIdentifier is required.
  • DashboardUrl is required.
  • AzureStorageConnectionString is required.
  • EngineId is an optional field. You can specify if you want it to run on a specific engine. If not specified, it will work with the default engine.

Request Body: 

{
  "name": "test client",
  "pointrCloudBaseURL": "https://sample-app-api.pointr.cloud/",
  "licenseKey": "c93f0101-36ed-4129-8f95-558f4cd8e82f",
  "clientExternalIdentifier": "Sample App Demo Ext",
  "dashboardUrl": "https://example-dashboard.pointr.cloud",
  "engineId": "ed410099-3383-473c-b356-d57f90654bc6",
  "azureStorageConnectionString": "DefaultEndpointsProtocol=https;...",
  "apiKey": "a17de7eb-31ef-4cc6-a056-4d0f2a40de54"
}

Success Response:

{
  "message": "Client configuration is updated."
}


* You can access the possible response codes you may encounter here.

Delete Client Configuration

Endpoint:

DELETE api/v9/mapscale/client-configurations/{clientIdentifier}

Description:

Deletes a specific client configuration using the clientIdentifier.

Success Response:

{
  "message": "Client configuration is successfully deleted"
}


* You can access the possible response codes you may encounter here.