WickrIO API Web Interface
Get started with the WickrIO Web API Interface:
Configuration:
- After installing the Web API Interface software module, you will need to configure several properties that are needed to access the URL endpoints. The WickrIO console will walk you through entering the following values:
- BOT_USERNAME = This is the username of the WickrIO client. If prompted enter that value.
- BOT_PORT = The network port the app is going to be listening on
- BOT_API_KEY = Custom API Key which will be used in every endpoint call, is the from table above.
- BOT_API_AUTH_TOKEN = Authentication string used to generate the Base64 value to be sent in a request Header (Recommended: 24-character alphanumeric string)
- HTTPS_CHOICE = Choose whether to use an HTTPS server instead of the default HTTP. It is highly recommended that HTTPS be used for security.
- SSL_KEY_LOCATION = Full path name of the .key file (only required if y was chosen for HTTPS_CHOICE)
- SSL_CERT_LOCATION = Full path name of the .cert file (only required if y was chosen for HTTPS_CHOICE)
For HTTPS and SSL support, you need an OpenSSL certificate file and a key file. Both can be created with the following command:
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout my.key -out my.cert
Usage:
- All of the endpoints and requirements are listed in WickrIO_Client_REST_API.doc