How to work with oAuth APIs
This is your reference for taking advantage of My OPSWAT Central Management APIs within your environment. Be sure to refer to OPSWAT Terms of Service as you develop your applications. Check back often as our APIs are growing to accommodate our user community as well as our platform.
Our APIs allow developers to easily integrate the data available through our My OPSWAT Central Management platform into your own applications. This data includes
- Device details such as device information (Host name, Device ID, MAC/IP Address,...)
- Device security and compliance status, such as Antivirus, Anti-phishing, Public File Sharing, and Malware detection as well as account information.
These APIs can be used to provide authentication and enforcement via a Secure Access solution (SSL VPN, NAC, etc) or can be integrated into a Remote Monitoring and Management platform for expansive visibility into the endpoints under management. The options are unlimited.
To work with our APIs, you can follow the below steps:
- Register an OAuth application to achieve a client key and client secret.
- Implement your application to interact with My OPSWAT Central Management APIs
Register your application
Before getting started, you will need to set up a My OPSWAT Central Management account in order to begin registering an oAuth applications to our platform. Once your account is created, you can registering an oAuth application. to obtain a Client Key and Client Secret strings for API authentication. These keys are unique and should remain confidential.
Before you register your application through the My OPSWAT Central Management oAuth Portal. You will be expected to provide the following information when registering:
- Application name
- Application description - purpose of the application
- Application URL - place where their application resides
- Callback URL - where user is redirected after authorizing application for access to the account
Implement your application
My OPSWAT Central Management leverages OAuth 2.0* technology, so you should be familiar with the OAuth 2.0 specifications and general flow to ensure that your application is capable of supporting the My OPSWAT Central Management APIs.
To help you get started with the My OPSWAT Central Management APIs, we have developed extensive documentation and sample applications. Click here read more about how to implement with the APIs or to download the sample code.
*OAuth 2.0 is an open protocol used by OPSWAT for authorization of access to resources within our platform. You can read more about OAuth 2.0 here.
Branding Guidelines
OPSWAT Logo and Guidelines
You are free to use the OPSWAT name and logo in relation to your application, including marketing materials and website content; however, we do ask that you follow the OPSWAT guidelines. If there are any questions, please contact the OPSWAT Team.