Configuring the Argos Web API
The Argos Web API allows third parties to programmatically query the Argos Vault data over
the web.
It
is important that the system is properly set up for the website to operate
correctly. That requires a number of
prerequisites to be installed on the web server and some system security
settings to be in place.
Database connection
The Web API can connect
to the database using either Windows authentication or SQL Server
authentication.
Windows Authentication
Set up a windows
user account which the website will use as the impersonation identity.
IIS Identity Settings
- Set this user up within SQL Server so that it has
permissions to access the Argos Vault SQL Database
- Create the IdentitySettings.config file and specify
the user details.
- Copy the IdentitySettings.config.example file and
rename it IdentitySettings.config. The example file can be found in the root
folder of the installed website.
- Configure the identitySettings.config file as follows
<identity
impersonate="true"
userName="<domain>\<username>"
password="<password>"/> - Replace <domain>, <username> and
<password> with the appropriate values
Connection Settings
- Create a ConnectionSettings.config file to specify the
Argos Vault database connection to use for the Websites.ยท
- Copy the ConnectionSettings.config.example file and
rename it ConnectionSettings.config. The
example file can be found in the root folder of the installed website.
- Set the connection details.
<add
name="APIServer" connectionString="Data Source=<db_server>\<instance>;Initial Catalog=<db_name>;Integrated Security=true"
providerName="System.Data.SqlClient" /> - Replace <db_server>, <instance> and
<db_name> with the appropriate values.
SQL Server Authentication Settings
Set up a user in SQL server with appropriate
permissions.
IIS Identity Settings
Configure the identitySettings.config file as follows
<identity
impersonate="false"/>
Database Connection Settings
- Create a
ConnectionSettings.config file to specify the Argos Vault database connection
to use for the Websites.
- Copy the
ConnectionSettings.config.example file and rename it
ConnectionSettings.config. The example
file can be found in the root folder of the installed website.
- Set the connection details.
<add name="APIServer"
connectionString="Data Source=<db_server>\<instance>;Initial Catalog=<db_name>;UID=<username>;PWD=<password>" providerName="System.Data.SqlClient" /> - Replace <db_server>, <instance>, <db_name>, <username> and <password> with the appropriate values.
Log Files
These are
written to the directory \App_Data\Logs found in the root folder of the
installed website.
Related Articles
Installing Argos Internal API
The Argos Internal API is used to power the Vault and Bailment applications. Note, this is available from Argos v6.0 onwards Installation Types The installer can be used to install a production instance of the Argos Internal API. Instructions to ...
Installing Argos Web API
Copy the latest Argos Vault Release file to the Web Server, (or locate the files over the network). Double click on the "Setup" icon in the Argos.ApiServer folder of the latest Argos Vault Release. Installation The following dialog will display: ...
Installation Instructions
Summary This set of documents details the initial setup requirements for the Argos software. It is recommended that the installation checklist from the appendices is printed as a step by step guideline for the installation task being undertaken. The ...
Internal API Setup
Purpose Allows configuration for the Internal API used to power Vault. Access Control | Internal API Setup Dialog Details Detail Specific Fields Field Description Internal API URL Enter the complete URL for the Internal API. You can press the "Use ...
Installation Prerequisites
Prerequisites The following section outlines the third-party applications required to successfully run Argos. The below applications are not provided as part of the Argos application and it is the responsibility of the client to purchase/licence, ...