Web APIs

The AVEVA™ Production Management Web APIs provide access to the application's API resources through intranet supported interface. These are REST APIs that serve as a wrapper on existing methods and do not affect existing data structure. The Web APIs include those that are built and consumed for integration to other products like AVEVA™ Work Tasks.

Authentication

Authentication is used to control access to the Web API resources. An authentication mechanism is applied to the Web API request, where a server-side certificate is used to secure a data transfer. The required user credentials can either be a Studio Basic user or a domain user account from an Active Directory group.

For Studio Basic users, the credentials provided are validated each time you send a request. For domain users, the credentials are cached and kept for 15 minutes to optimize the authentication process. However, if you send a request twice using a domain user account, and for each request, you use a different authentication type, the credentials are cached on the first instance. On your next request, because you use an authentication type different from the first one, the system validates your credentials again and ignores the cached credentials.

Note: The cached user credentials are for Web API use only and do not apply to the Production Analyst and Web Services login.

The supported authentication types are:

• Basic authentication - Accepts a Studio Basic user or domain user account from an Active Directory group. It uses the Ampla service to authenticate the user credentials before sending the request to the server.

• NTLM authentication - Accepts only a domain user account from an Active Directory group. It's a standard authentication type where the client authenticates itself using the provided credentials and generates a trusted token before sending the request to the server.

• Kerberos authentication - Accepts a domain user account from an Active Directory group. A protocol that does not require multiple requests for credentials.

• Token-based authentication - Accepts a domain user account from an Active Directory group. This protocol allows you to provide user credentials to an authentication service in exchange for an access token.

Related topics

• About Web services

• Web API Reference