Creating a SAP HANA API in Minutes with DreamFactory
Handwriting code for database APIs can be a time-consuming and expensive process that often exposes organizations to risks around quality, consistency,and ongoing developer effort.
DreamFactory specializes in automatic REST API generation for a wide range of databases, including SAP HANA. With just a few clicks you can generate a secure, fully documented API in minutes, rather than weeks. This guide walks through how to create an on-premise SAP HANA API and shows how DreamFactory can save your team considerable time, money, and effort in the API development process.
Generating the SAP HANA REST API
The SAP HANA connector follows the same pattern as other DreamFactory databaseservices:
- Connect to your database from the admin console
- Name and describe the service (this becomes part of the API URL)
- Configure access via Security Config and RBAC
- Use the auto-generated API docs to explore and test the API
Step 1: Select Your Database
To start building your SAP HANA REST API, you’ll login to the DreamFactory administration interface, choose Connect to Database
From there you’ll select the SAP HANA service type by finding the SAP HANA option or by searching for it in the search bar.
.png)
Step 2: Configure Your API
Here you will be prompted to provide a name, label, and description. The latter two are used just for reference purposes within the administration interface, however the name value is particularly important because as you’ll soon see it will comprise part of the API URL.
Then, you’ll be prompted to provide the database connection credentials after pressing ‘next.’. This should come as nothing new—you’ll provide a host name, username, password, database, and any other required credentials. Additionally, you can optionally specify advanced configuration options such as driver settings, additional SQL statements, caching preferences, maximum records, and more
.png)
Step 3: Choose your Security Access
Click on Security Config. Here you will be prompted to easily choose the type of access you want for this API service by just simply selecting each of the tiles and the type of read, write, or full access. This can also be adjusted later within the Role Bases Access Control Interface, giving you additional fine grained access controls. Once complete, simply select Apply Security Configuration. THAT'S IT!
You have now in less than 2 mins created a new REST API against SAP HANA that has automatically generated the database API, API Docs, RBAC, and the API Key that can be interrogated into your applications!
.png)
Step 4: Test out Your Newly Secured API
DreamFactory automatically scanned your SAP HANA database schema and generated full API Documentation end points for easy testing.
.png)
You can also test your API Key that was automatically generated for you when you set up your API right here in the DreamFactory Interface.
Simply click on Test API Authentication, choose the endpoints that you gave the database API access to during the security config and then select your API key from the Authentication method dropdown, and hit Test Auth.
.png)
These features ensure that APIs are easy to understand, use, and integrate, significantly reducing development time and enhancing collaboration across teams. The documentation is continuously updated to reflect any changes in the API, ensuring accuracy and reliability.
