Set Up Access to the Application API (IIS)

Once you have created API endpoints, you can access data in Intrexx from external sources, such as a smartphone app.

Authorization is required to access the Intrexx Application API. This is only done against Intrexx. Windows authentication integrated into IIS cannot be used for authorization with the Intrexx Application API.

The following section describes the steps you need to take if you are using IIS with integrated Windows authentication.

Initial Scenario

This description applies to you under the following conditions:

  • You are running Intrexx on Windows.

  • They use IIS (Internet Information Services) as their front-end web server.

  • They use Windows authentication, which is built into IIS.

  • You are using the Intrexx Application API.

(See also the sections Intrexx Architecture " and " Windows - Setting Up IIS (Internet Information Services).")

Authentication with the Intrexx Application API

Authentication with the Intrexx Application API is not possible using the Windows authentication integrated into IIS. Instead, you must configure anonymous access for the Intrexx Application API in IIS. In this process, authentication takes place only with Intrexx. This can be done either using the API key (Authentication via API Keys) or via API login (Authentication via the API login endpoint and cookies (without an API key)).

Key Steps

  • Create Directories in the Portal Directory

  • Configuring Authentication Settings in IIS

  • Modify the web.config file associated with the portal

  • Modify the applicationHost.config file that comes with Windows

  • Delete the directories previously created in the portal directory

Setting Up Anonymous Access in IIS

Step-by-Step

To set up anonymous access to the Intrexx Application API in IIS, follow these steps:

  1. Open Windows Explorer.

  2. In the portal directory, under "external > htmlroot," create the "api" directory and, within it, the "app" directory.

    The directory structure will then look like this:

    <intrexx-installation-directory>\org\<portal-directory>\external\htmlroot\api\app

  3. Start IIS.

  4. Select the "api" directory .

  5. Double-click "Authentication" .

    You will be taken to "Authentication."

  6. Under "Anonymous Authentication," set the status to "Enabled."

  7. Set all other authentication entries to "Disabled."

  8. Follow the same procedure for the "app" directory.

  9. Go back to Windows Explorer.

  10. Navigate to the directory<intrexx-installation-directory>\org\<portal-directory>\external\htmlroot.

    web.config

  11. Open the "web.config" file.

  12. Insert the following code into the file before the closing </configuration> tag:

    <location path="api"> <!-- relative to where the web.config file is located -->
    <system.web>
      <authorization>
        <allow users="*" />
      </authorization>
    </system.web>
    <system.webServer>
      <security>
        <authentication>
          <windowsAuthentication enabled="false" />
          <anonymousAuthentication enabled="true" />
        </authentication>
      </security>
    </system.webServer>
</location>

  13. Save the file.

  14. Navigate to the %WinDir%\System32\Inetsrv\Config directory.

    ApplicationHost.config

  15. Open the "ApplicationHost.config" file.

  16. Set the following properties of the <sectionGroup name="security"> or <sectionGroup name="authentication"> from "Deny" to "Allow":

    <section name="access" overrideModeDefault="Allow" />
<section name="anonymousAuthentication" overrideModeDefault="Allow" />
<section name="windowsAuthentication" overrideModeDefault="Allow" />

  17. Save the file.

  18. Restart IIS.

  19. Delete the "api" and "app" directories that were previously created in the portal directory under "external > htmlroot."

More Information