Authentication (headers)

In order to interact with the Silvasoft API, you or your application must authenticate. The Silvasoft API handles this through an API key which you can retreive from within your Silvasoft dashboard.

The API key functions as the most important part in the authentication process. In effect, it acts as a substitute for a password. Because of this, it is absolutely essential that you keep your API key secure. Upon generation from within Silvasoft, the web interface will only display the token a single time in order to prevent the token from being compromised.

So, in order to authenticate you must make sure you have the API module enabled in your Silvasoft account and you have an API key. To authenticate, Silvasoft expects two header parameters within every request: ApiKey and Username. The username obviously is the username you login to Silvasoft with.

Please note that you might need to add the header Content-Type as well with value “application/json” if your implementation does not add a valid content-type automatically.

An simple CURL example request can be found for every endpoint documentation on this website. The example includes the authentication headers.