SuperOffice WebApi Client Library
First things first!
Note
This is not an OAuth 2.0 client. When authenticating with OpenID Connect or OAuth, you still have to use another means to obtain OAuth tokens.
For OAuth/OpenID Connect authentication in web applications, we recommend you take a look at the AspNet.Security.OAuth.SuperOffice 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 has the exact same Agent-style services as SuperOffice.NetServer.Services 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.
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
- Learn about the WebAPI Agent endpoints.
- Learn about the WebAPI Client.
- Call the web services 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
.