Overview
The headless architecture feature of Developer Portal equips you with the APIs that you would require to build an application with the Developer Portal functionality.
The REST APIs that come along with the Developer Portal installation allow you to perform all functions that you can accomplish through the application's user interface.
Developer Portal REST APIs are located at SAGInstallDir\DeveloperPortal\developers\openapis.
Authentication to use Developer Portal REST APIs
The authentication method applicable for the Developer Portal REST APIs is HTTP Basic authentication.
Access privileges based authorization
The availability of API resources is based on the user privilege. Typically, users who have the API Administrator privilege have access to all APIs, whereas, the users who have any of the API Provider and API Consumer privileges have limited access of API resources.
REST APIs URI format
Developer Portal allows you to access the API resources using URI paths. The REST call URI must be specified with the required method in the format shown below:
Possible response messages
The following table lists the possible response messages and what they indicate:
Response message | Description |
200 - OK | Indicates the request sent and response received successfully. |
201 - Created | Indicates that the request is fulfilled, resulting in the creation of a new resource. |
400 - Bad request | Indicates that a parameter is missing in the request due to which it could not be processed. |
401 - Unauthorized | Indicates authorization problem. |
403 - Forbidden | Indicates that there is no permission to the requested resource. |
404 - Not found | Indicates that the requested resource does not exist. |
500 - Internal server error | Indicates that an unexpected condition is encountered and no more specific message is suitable. |
List of APIs
The REST APIs allow you to perform the following:
