Using Viya APIs with OAuth clients
The Viya platform is an open platform that allows users to interact with it in the way they choose. Whether this is through the SAS Viya web interfaces, IDEs, Open Source libraries or APIs. While a lot of documentation exists around the use of the SAS Viya APIs, it may be difficult to oversee the entire chain of events and related requirements that exist when working with these APIs. This is especially true when using OAuth clients to use these APIs non-interactively instead of regular end-user accounts. It is these scenarios where this document focuses on.
This document tries to capture the different stages involved in using the Viya APIs and provide the requirements that need to be fulfilled when using specific parts of the API. The SAS Viya API is extensive, and so this document does not attempt to capture every single use case. It rather categorized API usage into different categories requiring different prerequisites to be met. For detailed information on all the API endpoints that are available for SAS Viya, please visit SAS Developers
API usage stages
Interaction with SAS Viya APIs can be divided in five different stages, of which the last two are optional. There are some closing remarks in the final sixth stage.
- Identification & Authentication
- Authorization and API Interaction
- SAS Runtime usage (optional)
- External services usage (optional)
- Closing Remarks
Depending on the type of API request that you want to make, different choices will have to be made during each of these phases. This document will discuss these phases in sequence.