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 explore 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 select Authorize:

clipboard_e000bad8e3fa135950e49c2af92f2289a.png

  1. Select Authorize again and log in to your site with a username and password (OAuth).

clipboard_e6ac4ac3b87adbf903c49a95d11a34f45.png

  1. When the authorization is complete, close the dialog box in the Swagger interface and explore the API!

 

If you're running Fotoware On-Premises

If you're running an on-premises version of Fotoware, you need to register the Fotoware API site as an application on your Fotoware site before you can authorize a connection: 

  1. From the Tools menu (cogwheel icon), go to Site Configuration > Integrations > Applications.
  2. Select Add application.
  3. Enter the following values: 

 

  1. Select Save.

Enabling CORS

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

  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, see the IIS CORS module official documentation (external link). Not all configurations will work with the FotoWeb API; only configurations documented here have been tested. If you think your configuration should work but doesn't, and it is required (due to a security policy required by your IT team, for example), contact Fotoware for support.

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 URL to the Site field at the top of the screen and select Authorize:

clipboard_e2b8e1926069863ec930f478014b236eb.png

  1. Select Authorize again and log in to your site with a username and password (OAuth):

clipboard_e6ac4ac3b87adbf903c49a95d11a34f45.png

  1. When the authorization is complete, close the dialog box in the Swagger interface and explore the API!