Adding a response center with the Skyresponse Admin API
is all about performing the POST
method to /api/responsecenters
.
There is one required field that must be fetched from an endpoint before adding the new response center: CustomerId
. Below, you will find the steps describing how to fetch this value.
Note that in order to create a response center you must first have created a customer who can own the response center.
Note that some of the features that can be controlled via the API are related to the permissions assigned to your access token (seller, customer etc. with subcategories). Please contact Skyresponse support if any Forbidden
responses occur.
CustomerId
In order to get the correct CustomerId
you should perform a request to /api/customer
.
GET /api/customers HTTP/1.1
Host: https://admin.skyresponse.com
Authorization: Bearer tkgY9yiM...plBp```
*If you don't know how to get the `Authorization` header, please proceed to the [Authentication](../../getting-started/login) tutorial*
If the authorization is OK, you will recieve a list of all customers in `JSON` format:
```JSON
[
{
"Name": "Skyresponse Demo",
"Identifier": 132,
"ParentIdentfier": null,
"RequireCostCenter": false
}
]
Where the Identifier
value should be used as CustomerId
.
The following HTTP signature provides the minimal subset of fields required to be in the JSON body
:
POST /api/responsecenters HTTP/1.1
Host: https://admin.skyresponse.com
Content-Type: application/json
Authorization: Bearer tkgY9yiM...plBp
{
"Name": "Demo Response Center",
"CustomerId": 123
}
If you provide the correct values, you should recieve an HTTP 202 Accepted
response from the server.
There are some helpers that can be used to pre-configure your response center, such as: CopyFromResponseCenterId
, CopyAlarmCodeRules
, CopyAlarmCodes
, CopyIntegrationRules
etc. Explore the full API documentation for more information on these helpers.
{
"data": {
"responceCenterId": 428,
"name": "Demo Customer"
},
"errors": null
}
Also, you can add interactions
, alarm codes
and contacts
to your response center. Check out the full documentation for more information on this.
cURL
example:Example of add new response center:
curl -X POST -H "Content-Type: application/json" 'https://admin.skyresponse.com/api/responsecenters' -H "Authorization: Bearer PASTE_YOU_TOKEN_HERE" -d '{"Name": "Demo Customer", "CustomerId": 132}'
Adding a response center with the Skyresponse Admin API
is all about performing the POST
method to /api/responsecenters
.
There is one required field that must be fetched from an endpoint before adding the new response center: CustomerId
. Below, you will find the steps describing how to fetch this value.
Note that in order to create a response center you must first have created a customer who can own the response center.
Note that some of the features that can be controlled via the API are related to the permissions assigned to your access token (seller, customer etc. with subcategories). Please contact Skyresponse support if any Forbidden
responses occur.
CustomerId
In order to get the correct CustomerId
you should perform a request to /api/customer
.
GET /api/customers HTTP/1.1
Host: https://admin.skyresponse.com
Authorization: Bearer tkgY9yiM...plBp```
*If you don't know how to get the `Authorization` header, please proceed to the [Authentication](../../getting-started/login) tutorial*
If the authorization is OK, you will recieve a list of all customers in `JSON` format:
```JSON
[
{
"Name": "Skyresponse Demo",
"Identifier": 132,
"ParentIdentfier": null,
"RequireCostCenter": false
}
]
Where the Identifier
value should be used as CustomerId
.
The following HTTP signature provides the minimal subset of fields required to be in the JSON body
:
POST /api/responsecenters HTTP/1.1
Host: https://admin.skyresponse.com
Content-Type: application/json
Authorization: Bearer tkgY9yiM...plBp
{
"Name": "Demo Response Center",
"CustomerId": 123
}
If you provide the correct values, you should recieve an HTTP 202 Accepted
response from the server.
There are some helpers that can be used to pre-configure your response center, such as: CopyFromResponseCenterId
, CopyAlarmCodeRules
, CopyAlarmCodes
, CopyIntegrationRules
etc. Explore the full API documentation for more information on these helpers.
{
"data": {
"responceCenterId": 428,
"name": "Demo Customer"
},
"errors": null
}
Also, you can add interactions
, alarm codes
and contacts
to your response center. Check out the full documentation for more information on this.
cURL
example:Example of add new response center:
curl -X POST -H "Content-Type: application/json" 'https://admin.skyresponse.com/api/responsecenters' -H "Authorization: Bearer PASTE_YOU_TOKEN_HERE" -d '{"Name": "Demo Customer", "CustomerId": 132}'