The Reference For Rpcm Rest Api; General Information - RCNTEC RPCM Series User Manual

5. The Reference for RPCM REST API

5. The Reference for RPCM REST API

5.1. General information

5.1.1 Accessing REST API
REST API is available on TCP port 8888 using non-encrypted HTTP protocol.
The REST API is available over the protocols
for HTTP — TCP port 8888;
for HTTPS — TCP port 8443.
5.1.2 Authentication
By default endpoint is available without authentication. API authentication can be switched on in
web interface or via command line interface.
Once authentication is turned on, it is necessary to include the API key with each request. Two
methods of API key inclusion are supported:
First method — in the body of URL:
for HTTP:
curl -X GET http://192.168.1.24:8888/api/cachedStatus?apikey=373ac3fde3ae0740e0fb76e912e3e18e
for HTTPS:
curl -k -X GET https://192.168.1.24:8443/api/cachedStatus?apikey=373ac3fde3ae0740e0fb76e912e3e18e
Second method — in the header of HTTP/HTTPS.
for HTTP:
curl -X GET http://192.168.1.24:8888/api/cachedStatus -H API-KEY:373ac3fde3ae0740e0fb76e912e3e18e
for HTTPS:
curl -X GET https://192.168.1.24:8443/api/cachedStatus -k -H API-KEY:373ac3fde3ae0740e0fb76e912e3e18e
If API keys are provided both ways, the key, provided inside of the URL will be used.
Further descriptions and examples of requests and replies in this paragraph assume
authentication is switched off.
If the service is unavailable, the message is:
'{"resultOfLastCommand":"FAILED","reason":"SERVICE_UNAVAILABLE"}'
160