> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice WebApi Client Library

> Describes the SuperOffice WebApi library, a REST client for SuperOffice web services.

First things first!

<Note>
  **This is not an OAuth 2.0 client**. When authenticating with [OpenID Connect][5] or [OAuth][4], you still have to use another means to obtain OAuth tokens.
</Note>

For OAuth/OpenID Connect authentication in web applications, we recommend you take a look at the [AspNet.Security.OAuth.SuperOffice][1] provider. It's an open source library created by DevNet, and tailored for SuperOffice online.

Now lets begin looking how to use the `SuperOffice.WebApi` library.

## What is SuperOffice.WebApi

The WebApi Client offers an alternative to the existing SuperOffice NetServer WCF proxies. **[SuperOffice.WebApi][2]** has the exact same Agent-style services as [SuperOffice.NetServer.Services][1] while adopting modern practices, such as asynchronous methods.

This library is a **.NET Standard 2.0 library** that works with both .NET Framework (4.6.1 and higher) and .NET Core (2.0 and higher) applications.

[1]: https://www.nuget.org/packages/SuperOffice.NetServer.Services

[2]: https://www.nuget.org/packages/SuperOffice.WebApi

OK. So that's what the `SuperOffice.WebApi` library is, now lets see how to use it.

## Getting started

* Read the introduction to [SuperOffice web services][6]
* Learn about the [WebAPI Agent endpoints][3].
* Learn about the [WebAPI Client][2].
* [Call the web services][7] through the WebAPI Client library.
* Check out the reference in the left menu.

## Package dependencies

These will automatically be included when you add the `SuperOffice.WebApi` package to a project.

.NETStandard 2.0

* Microsoft.Extensions.Logging.Abstractions (>= 5.0.0)
* Microsoft.IdentityModel.JsonWebTokens (>= 5.6.0)
* Microsoft.IdentityModel.Logging (>= 5.6.0)
* Microsoft.IdentityModel.Tokens (>= 5.6.0)
* Newtonsoft.Json (>= 12.0.2)
* System.Security.Permissions (>= 4.7.0)

## Known issues

The current `SuperOffice.WebApi` package dependencies are not the latest Microsoft packages available. Therefore, if your project uses newer versions of the Microsoft packages, there will be conflicts with `TokenValidationResult`.

[1]: https://www.nuget.org/packages/AspNet.Security.OAuth.SuperOffice/

[2]: ../../web-services/proxies/index

[3]: ../../web-services/endpoints/agents-webapi/index

[4]: ../../authentication/online/index#oauth

[5]: ../../authentication/online/index#oidc

[6]: ../../web-services/index

[7]: ../../web-services/proxies/superoffice-webapi/index


## Related topics

- [SuperOffice WebApi Client Library](/en/api/reference/webapi/index.md)
- [SuperOffice.WebApi.Agents.ApiAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ApiAgent.md)
- [SuperOffice.WebApi.Agents.IApiAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IApiAgent.md)
- [SuperOffice WebApi](/en/api/web-services/webapi/index.md)
- [Create your first application and connect to SuperOffice web services](/en/developer-portal/getting-started/quickstart.md)
- [SuperOffice.WebApi.Data.DashTileUsage](/en/api/reference/webapi/SuperOffice.WebApi.Data.DashTileUsage.md)
- [SuperOffice.WebApi.Data.CultureDataFormatter](/en/api/reference/webapi/SuperOffice.WebApi.Data.CultureDataFormatter.md)
