Skip to main content
Documentation & User Guides | FotoWare

Exploring the FotoWare API with Swagger

Public documentation of the FotoWare endpoints with Swagger (OpenAPI) is available at https://api.fotoware.com. Using this site you can authorize the site's connection to your FotoWare SaaS tenant and start exploring the entire API.

If you're using FotoWare as a Service

  1. Go to https://api.fotoware.com
  2. Add your FotoWare tenant's url to the Site field at the top of the screen and click on Authorize:

clipboard_e000bad8e3fa135950e49c2af92f2289a.png

  1. Click on Authorize again and log in with to your site with a user name and password (OAuth)

clipboard_e6ac4ac3b87adbf903c49a95d11a34f45.png

  1. When the authorization completes, close the dialog box in the Swagger interface and start exploring the API!

 

If you're running FotoWare on-premises

If you're running an on-premises version of FotoWare, you will need to register the FotoWare API site as an application in the OAuth section on your FotoWare site before you can authorize a connection: 
Open the Operations Center on the FotoWare server and go to the FotoWare site configuration. On the Settings tab, find the Applications node and click on the button labeled Add application.

Fill in the following values (see screenshot)

clipboard_ec40006ece0fa53df3daba9953191629c.png

 

Enabling CORS

You will need to enable CORS for the origin https://api.fotoware.com. Here's how:

This only works if FotoWeb is hosted on IIS. If you are hosting FotoWeb on Apache, please consider switching to IIS, 
as Apache support is deprecated.
  1.  Install Microsoft's IIS CORS module from https://www.iis.net/downloads/microsoft/iis-cors-module
  2. Find the web.config file of the IIS website on which your FotoWeb site is hosted.

DO NOT modify the web.config file in the Documents folder of the FotoWeb site! Your changes will be overwritten with every update. Instead, the web.config file of the website is free for you to customize. You can find its location by right-clicking on the website in IIS Manager and selecting "Explore". For example, for "Default Web Site", the location of the configuration file is typically C:\inetpub\wwwroot\web.config. If you create additional web sites, then each will have its own configuration file in a separate location that you choose, and you can and need to configure CORS separately for each site.

  1.  Add the following XML block under the <system.webServer> XML tag:
<cors enabled="true">
 <add origin="https://your-application.net" maxAge="120">
   <allowMethods>
     <add method="*"/>
   </allowMethods>
   <allowHeaders>
     <add header="*"/>
   </allowHeaders>
 </add>
</cors>

 This enables CORS from the given domain (in this case, https://your-application.net)

For more detailed configuration options, please see the official documentation of the IIS CORS module (external link). Please note that not all possible configurations will work with the FotoWeb API and only configurations documented here have been tested. If you think your configuration should work, but doesn't, and it is required (e.g., due to a security policy dictated by your IT team), please submit a support request to FotoWare.

After registering the application and enabling CORS

Having registered the application on your FotoWare site and made the necessary CORS adjustments, authorize the FotoWare API:

  1. Go to https://api.fotoware.com
  2. Add your FotoWare site's url to the Site field at the top of the screen and click on Authorize:

clipboard_e2b8e1926069863ec930f478014b236eb.png

  1. Click on Authorize again and log in with to your site with a user name and password (OAuth):

  1. When the authorization completes, close the dialog box in the Swagger interface and start exploring the API!