The following provides a general list of the steps you must take to create an API in the API Designer:
Start the API Designer.
Create API files (in which you can define an API method, for example).
Create an API project.
Configure the authentication for the API project (Single Sign-On, for example).
Assign the created API files to the API project.
Test the API.
Compile the API.
Save the changes to the database.
This section provides you with general information on working with the API Designer.
For example, you will learn:
and much more.
Before you start developing your API, you must start the API Designer.
To start the API Designer
Go to the installation path for API Designer.
Run the ApiDesigner.Editor.exe application.
The API Designer opens.
Perform one of the following tasks:
To use an existing connection to the One Identity Manager database, select it in the Select a database connection menu.
To create a new connection to the One Identity Manager database, click Add new connection and enter a new connection.
Select the authentication method and enter the login data for the database under Authentication method.
Click Connect.
In the Select project save type dialog, perform one of the following tasks:
Click Database project to save the project in the database.
Click Solution project to save the project within a solution.
TIP: For more information, see Project types.
(Optional) To save the selected storage type for future projects, select the Use selected project as default option.
Click OK.
The API Designer opens and displays the start page.
The API Designer distinguishes between two different project types for saving your changes.
Database project: The project will be stored in the database. Your saved changes are visible to others.
Solution project: API Designer allows file-based editing of custom objects locally on your own computer. For more information, see Solution projects.
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
