Skip to content
This repository has been archived by the owner on May 13, 2023. It is now read-only.

Commit

Permalink
Added ReadMe on configuring Shiftplan API
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasanker committed Oct 1, 2019
1 parent 97ae7e5 commit 55698b0
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions API/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Configuration of API

Both the `Public API` and `API` solutions relies on a `appSettings.config` and `connections.config` to run. Both solutions depend on the same `connections.config` file since they connect to the same data source.

The config files are saved in the root of the ASP.NET project.

`connections.config`
```xml
<connectionStrings>
<add name="ShiftPlannerDataContext"
providerName="System.Data.SqlClient"
connectionString=""/>
</connectionStrings>
```

## Public API

The `Public API` solution needs the following configuration:

`appSettings.config`

```xml
<appSettings>
<add key="databaseSchema" value="" /> <!-- Database Schema used, either prod or test -->
</appSettings>
```



## API

The `API` solution needs the following configuration:

`appSettings.config`

```xml
<appSettings>
<add key="ApiKey" value=""/> <!-- -->
<add key="TokenKey" value=""/> <!-- Token key for TokenManager -->
<add key="TokenAgeHour" value="24"/> <!-- Token expiration -->
<add key="podio_app_id" value=""/> <!-- Must refer exactly the Podio app and view for Applicants -->
<add key="podio_app_token" value=""/> <!-- Podio API credentials -->
<add key="podio_client_id" value=""/>
<add key="podio_client_secret" value=""/>
<add key="podio_applicants_app_id" value=""/> <!-- Must refer exactly the Podio app and view for Applicants -->
<add key="podio_view_id" value=""/>
<add key="ftpUsername" value=""/> <!-- FTP credentials and host (location) for saving the member pictures -->
<add key="ftpPassword" value=""/>
<add key="ftpHost" value=""/>
<add key="databaseSchema" value="test" /> <!-- Database Schema used, either prod or test -->
</appSettings>
```

0 comments on commit 55698b0

Please sign in to comment.