[PDF] 5 How to Configure SAP API Management Edge - SAP Help Portal PDF SAP_API_Management_Technical_Operations

To connect, specify the Bind DN or user of cn=manager,dc=apigee,dc=com and the OpenLDAP password that you set at the time of SAP API Management Edge

You are all set Access your Apigee instance by signing in here: https://login apigee com/login Sign-up for Apigee Edge trial account If you're new to Apigee,

[PDF] Operations Guide - Apigee Docs

To connect, specify the Bind DN or user ofаcn=manager,dc=apigee,dc=com аand the OpenLDAP password that you set at the time of Edge installation 2

[PDF] Apigee guide - Nielsen API Portal

Note: Consumer Key is a synonym for API key 4 API KEY ACCESS USE Step 1: If already logged in, please proceed to Step 2, else Log

[PDF] Apigee Edge Troubleshooting Guide

31 juil 2017 · onConnectTimeout Error indicates that Message Processor was unable to connect to the backend server within the preset connection time out

[PDF] 5 How to Configure SAP API Management Edge - SAP Help Portal

To connect, specify the Bind DN or user of cn=manager,dc=apigee,dc=com and the OpenLDAP password that you set at the time of SAP API Management Edge

[PDF] apigee - SAP Help Portal

To enable authentication: · Update all SAP API Management Edge components that connect to Cassandra with the Cassandra username and password · On all

[PDF] Apigee hybrid - Price 2 Meet

23 août 2020 · https://cloud google com/apigee/api-management/hybrid/ 1/6 (//login apigee com/sign__up?int_source=website&int_medium=get-

[PDF] Apigee developer po al - Price 2 Meet

23 août 2020 · Developer portal Apigee Google Cloud https://cloud google com/apigee/api- management/developer-portal/ (//login apigee com/sign__up?

[PDF] apigee logo

[PDF] apigee management api

[PDF] apigee meaning

[PDF] apigee on premise

[PDF] apigee on premise pricing

[PDF] apigee pdf

[PDF] apigee pricing cloud

[PDF] apigee saas

[PDF] apigee sense pricing

[PDF] apigee sla

[PDF] apigee standard pricing

[PDF] apigee tool

[PDF] apigee tutorial

[PDF] apigee tutorial pdf

[PDF] apigee vs mulesoft

Technical OperationsGuideCUSTOMER

SAP API Management, On-Premise Edition

CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

Typographic ConventionsTypographic Conventions

Type StyleDescription

ExampleWords or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Textual cross-references to other documents.ExampleEmphasized words or expressions. EXAMPLETechnical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they

are surrounded by body text, for example, SELECT and INCLUDE.ExampleOutput on the screen. This includes file and directory names and their paths, messages,

names of variables and parameters, source text, and names of installation, upgrade and database tools. ExampleExact user entry. These are words or characters that you enter in the system exactly as

they appear in the documentation.Variable user entry. Angle brackets indicate that you replace these words and characters

with appropriate entries to make entries in the system. EXAMPLEKeys on the keyboard, for example,F2 orENTER.

SAP API Management, On-Premise Edition

Document History CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

All rights reserved.3Document History

VersionDateChange

1.0<2014-08-01> Document Creation1.1<2016-04-28>Document aligned with SP04 release

1.2<2016-06-21> Document aligned with SP05 release1.3<2016-10-14>Document aligned with SP06 release

1.4<2017-05-03> Document aligned with SP07 release1.5<2017-11-21>Document aligned with SP08 release

CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

Table of ContentsTable of Contents

Data Protection and Privacy ............................................................................................................. 10

1Overview .................................................................................................................................. 11

2Architectural Overview .......................................................................................................... 12

2.1Component Description ....................................................................................................................... 12

2.1.1Critical API Processing Components ................................................................................. 12

2.1.2Non-Critical API Processing Components ......................................................................... 13

3About Planets, Regions, Pods, Organizations, Environments and Virtual Hosts ............... 14

3.1About Planets ........................................................................................................................................ 15

3.2About Regions ....................................................................................................................................... 15

3.3About Pods ............................................................................................................................................ 17

3.4About Organizations.............................................................................................................................19

3.5About Environments............................................................................................................................ 20

3.6About Virtual Hosts .............................................................................................................................. 21

3.7Creating your first organization, environment, and virtual host ..................................................... 22

4Installation File System .........................................................................................................23

4.1Installation Directory ........................................................................................................................... 23

4.2File System Structure.......................................................................................................................... 23

4.3Important Data to Remember from the Installation Process .......................................................... 24

5How to Configure SAP API Management Edge ....................................................................25

5.1How to use .properties files ................................................................................................................ 25

5.2Location of .properties files ................................................................................................................ 26

5.3Determining the current value of a token .......................................................................................... 26

5.4Setting tokens in .properties files....................................................................................................... 27

5.5Setting a token that takes multiple values ........................................................................................ 27

5.6Locating a token .................................................................................................................................. 28

5.7Setting a token that is currently commented out ............................................................................. 28

6Using the apigee-adminapi.sh utility ................................................................................... 30

6.1Installing apigee-adminapi.sh ............................................................................................................. 30

6.2apigee-adminapi.sh syntax ................................................................................................................. 30

6.3Setting parameters using command-line switches and environment variables ............................ 31

6.4Passing a file to the apigee-adminapi.sh utility ................................................................................. 32

6.5Displaying debug and API information .............................................................................................. 33

7Post Installation Tasks ..........................................................................................................35

7.1Reset Passwords ................................................................................................................................. 35

7.1.1Resetting SAP API Management Edge Password ............................................................ 35

7.1.2Resetting SAP API Management BaaS Passwords .......................................................... 43

7.1.3Managing the Default LDAP Password Policy for API Management .............................. 44

SAP API Management, On-Premise Edition

Table of Contents CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

7.2.1Customizing SAP API Management Email Templates ..................................................... 48

7.2.2Configuring the SAP API Management Edge SMTP server .............................................49

7.2.3Configuring SMTP for the SAP API Management BaaS SMTP Server ...........................50

7.2.4Set the expiration time for user activation links in activation emails .............................50

7.3Configure Logging ................................................................................................................................ 51

7.3.1Setting the log level for a SAP API Management Edge component ................................ 51

7.3.2Setting log file location ........................................................................................................ 52

7.4Configure the SAP API Management Edge UI ................................................................................... 52

7.4.1Setting the Session Timeout in the SAP API Management Edge UI ............................... 52

7.4.2Setting the port number of the SAP API Management Edge UI ...................................... 53

7.4.3Enabling the consent banner .............................................................................................. 53

7.4.4Setting the URL of the Developer Services portal ............................................................ 54

7.4.5Allowing the SAP API Management UI Access to Local IP addresses ............................ 55

7.4.6Allow custom reports longer than 14 days in the SAP API Management Edge UI ......... 57

7.4.7Setting the password hint text in the SAP API Management Edge UI ............................ 57

7.4.8Configure rules used to auto generate SAP API Management Edge UI passwords ...... 58

7.4.9Configure the SAP API Management Edge UI to store session information in memory

............................................................................................................................................... 59

7.5Configure Router and Message Processor ....................................................................................... 60

7.5.1Enabling/Disabling Server (Message Processor/Router) Reachability ....................... 60

7.5.2Setting HTTP request/response header limits ................................................................ 61

7.5.3Configuring the Router to retry connections to a Message Processor .......................... 62

7.5.4Configure Forward Proxying from SAP API Management Edge to a Backend Server ..64

7.5.5Set the message size limit in the Router or Message Processor .................................... 65

7.6Starting, Stopping, and Restarting SAP API Management .............................................................. 67

7.6.1Starting, Stopping and Restarting an Individual Service .................................................68

7.7Setting Server Autostart .....................................................................................................................69

7.8Uninstalling SAP API Management Edge ........................................................................................... 70

7.9Replacing the SAP API Management Edge license file ..................................................................... 70

7.10Viewing Pod Details ............................................................................................................................. 71

7.11Enable access to OAuth 2.0 tokens by user ID and app ID .............................................................. 72

7.11.1Procedure for enabling token access ................................................................................ 74

8Scaling SAP API Management Edge ..................................................................................... 77

8.1Adding a Router or Message Processor node ................................................................................... 77

8.1.1Add a Router ........................................................................................................................ 77

8.1.2Add a Message Processor .................................................................................................. 78

8.1.3Add both a Router and a Message Processor ................................................................... 79

8.2Removing a Server (Management Server/Message Processor/Router) ...................................... 79

8.3Adding Cassandra nodes .................................................................................................................... 79

8.3.1Existing SAP API Management Edge configuration ........................................................ 80

8.3.2Modifying the config file to add the three new Cassandra nodes .................................. 80

8.3.3Configure SAP API Management Edge .............................................................................. 81

8.4Adding ZooKeeper nodes .................................................................................................................... 83

8.4.1Existing SAP API Management Edge configuration ......................................................... 83

8.4.2Modifying the config file to add the three new ZooKeeper nodes ................................... 84

8.4.3Configure SAP API Management Edge .............................................................................. 85

8.4.4Validate the installation ...................................................................................................... 87

8.5Adding or removing Qpid nodes ......................................................................................................... 87

CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

Table of Contents8.5.1Add a Qpid server ................................................................................................................ 87

8.6Adding a data center ........................................................................................................................... 90

8.6.1Considerations before adding a data center .................................................................... 90

8.6.2Updating the existing data center ..................................................................................... 92

8.6.3Creating the configuration files.......................................................................................... 92

8.6.4Procedure to add a new data center ................................................................................. 93

9Configuring TLS/SSL ........................................................................................................... 98

9.1Creating a JKS file ................................................................................................................................ 98

9.2Generating an obfuscated password ................................................................................................. 99

9.3Configuring TLS/SSL between a Router and a Message Processor ............................................ 100

9.4Configuring TLS for the management API ...................................................................................... 102

9.4.1Ensure that your TLS port is open ................................................................................... 102

9.4.2Configure TLS .................................................................................................................... 102

9.4.3Configure the SAP API Management Edge UI to use TLS to access the Edge API ..... 103

9.4.4TLS properties for the Management Server ................................................................... 104

9.5Configuring TLS for the SAP API Management UI .......................................................................... 105

9.5.1Ensure that your TLS/SSL port is open .......................................................................... 105

9.5.2Configure TLS .................................................................................................................... 106

9.5.3Configure the Edge UI when TLS terminates on the load balancer .............................. 106

9.6TLS/SSL Enablement for API Proxy ................................................................................................ 107

9.6.1Prerequisite ....................................................................................................................... 107

9.6.2Procedure .......................................................................................................................... 107

9.7Configuring TLS for SAP API Management BaaS ............................................................................ 110

9.7.1TLS configuration options ................................................................................................. 110

9.7.2Ensure that the TLS port is open ...................................................................................... 112

9.7.3Configuring TLS on the API BaaS Stack .......................................................................... 112

9.7.4Configuring the Portal to access the Stack over TLS ..................................................... 114

9.7.5Configuring TLS on the API BaaS Portal .......................................................................... 114

9.7.6Configure API BaaS Stack nodes for TLS on the Stack or Portal .................................. 116

10Maintenance Tasks ............................................................................................................... 117

10.1Recurring SAP API Management Edge Services Maintenance Tasks ........................................... 117

10.2About Cassandra Replication Factor and Consistency Level ......................................................... 118

10.2.1About the Cassandra replication factor ........................................................................... 118

10.2.2About the Cassandra consistency level ........................................................................... 119

10.3Apache Cassandra Maintenance Tasks .......................................................................................... 120

10.3.1Anti-Entropy Maintenance ............................................................................................... 120

10.3.2Log File Maintenance ........................................................................................................ 120

10.4Apache Zookeeper Maintenance ...................................................................................................... 121

10.4.1About Zookeeper and SAP API Management Edge ........................................................ 121

10.4.2About leaders, followers, voters and observers ............................................................. 122

10.4.3Adding nodes as voters or observers .............................................................................. 123

10.4.4Maintenance Considerations ........................................................................................... 123

10.4.5Summary ........................................................................................................................... 125

10.5Apache Zookeeper Maintenance Tasks .......................................................................................... 125

10.5.1Four-Letter Commands .................................................................................................... 125

10.5.2Removing Old Snapshot Files .......................................................................................... 125

10.5.3Log File Maintenance ........................................................................................................ 126

10.6OpenLDAP Maintenance Tasks ........................................................................................................ 126

SAP API Management, On-Premise Edition

Table of Contents CUSTOMER

10.7.1Create an LDAP resource ................................................................................................. 126

10.7.2List all LDAP Resources .................................................................................................... 129

10.7.3Get the Details of an LDAP Resource .............................................................................. 129

10.7.4Update an LDAP Resource ............................................................................................... 129

10.7.5Delete an LDAP Resource ................................................................................................. 130

10.8Recurring Analytics Services Maintenance Tasks ........................................................................... 131

10.8.1Pruning Analytics Data....................................................................................................... 131

10.9Moving SAP API Management Servers ............................................................................................ 132

10.9.1Changing the IP Address of a Cassandra Node .............................................................. 132

10.9.2Changing the IP Address of a ZooKeeper Node ............................................................. 135

10.9.3Changing the IP Address of a LDAP Server (OpenLDAP) .............................................. 136

10.9.4Changing the IP Address of Other SAP API Management Node Types ....................... 136

10.10Handling a PostgresSQL Database Failover .................................................................................... 137

10.11Modifying Java Memory Settings ..................................................................................................... 138

11Organization and Environment Maintenance ..................................................................... 139

11.1Organization ....................................................................................................................................... 139

11.2Environment ....................................................................................................................................... 139

11.3Checking Status of Users, Organization and Environment ............................................................ 139

11.4About using config files ..................................................................................................................... 140

11.5Virtual host ......................................................................................................................................... 140

11.5.1Options when you do not have a DNS entry for the virtual host .................................... 141

11.6Creating an Organization, Environment, and Virtual Host .............................................................. 141

11.6.1Creating an Organization, Environment, and Virtual Host at the same time ................ 141

11.6.2Create an Organization ..................................................................................................... 143

11.6.3Create an organization by using API calls ....................................................................... 143

11.6.4Create an Environment ..................................................................................................... 144

11.6.5Create an environment by using API calls ....................................................................... 145

11.6.6Create a Virtual Host ......................................................................................................... 147

11.7Deleting an Organization/Environment/Virtual Host .................................................................... 147

11.7.1Delete a Virtual Host ......................................................................................................... 147

11.7.2Dissociate an Environment from Message Processor ................................................... 148

11.7.3Cleanup analytics .............................................................................................................. 148

11.7.4Delete an Environment...................................................................................................... 148

11.7.5Delete an Organization...................................................................................................... 148

11.8Adding a new analytics group ........................................................................................................... 150

12Managing Users, Roles, and Permissions ........................................................................... 153

12.1Adding a user ...................................................................................................................................... 153

12.2Assigning the user to a role in an organization................................................................................ 154

12.3Adding a system administrator ........................................................................................................ 154

12.4Changing the default system administrator user ........................................................................... 156

12.5Specifying the email domain of a system administrator ................................................................ 157

12.6Deleting a user.................................................................................................................................... 157

13Backup and Restore ............................................................................................................. 158

13.1What to Backup .................................................................................................................................. 158

13.2Recovery time objective (RTO) vs. Recovery point objective (RPO) ............................................ 158

13.3Before You Start: Useful Facts ......................................................................................................... 159

CUSTOMER

Table of Contents13.4How to Perform Backup .................................................................................................................... 159

13.5How to Perform a Restore ................................................................................................................ 160

13.6How to Restore a Component to an Existing Environment ............................................................ 161

13.6.1Apache ZooKeeper ............................................................................................................ 161

13.6.2Apache Cassandra ............................................................................................................ 162

13.6.3PostgreSQL database ....................................................................................................... 163

13.6.4Postgres Server ................................................................................................................. 163

13.6.5Qpidd database ................................................................................................................. 164

13.6.6Qpid Server ........................................................................................................................ 164

13.6.7OpenLDAP ......................................................................................................................... 164

13.6.8Management Server ......................................................................................................... 164

13.6.9Message Processor ........................................................................................................... 165

13.6.10Router................................................................................................................................. 165

13.6.11SAP API Management Edge UI......................................................................................... 165

13.7How to Reinstall and Restore Components .................................................................................... 166

13.7.1Apache ZooKeeper ........................................................................................................... 166

13.7.2Apache Cassandra ............................................................................................................ 167

13.7.3PostgreSQL database ....................................................................................................... 168

13.7.4Postgres Server ................................................................................................................. 169

quotesdbs_dbs17.pdfusesText_23

[PDF] [PDF] 5 How to Configure SAP API Management Edge - SAP Help Portal

Technical OperationsGuideCUSTOMER

SAP API Management, On-Premise Edition

CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

Typographic ConventionsTypographic Conventions

Type StyleDescription

SAP API Management, On-Premise Edition

Document History CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

All rights reserved.3Document History

VersionDateChange

1.0<2014-08-01> Document Creation1.1<2016-04-28>Document aligned with SP04 release

1.2<2016-06-21> Document aligned with SP05 release1.3<2016-10-14>Document aligned with SP06 release

1.4<2017-05-03> Document aligned with SP07 release1.5<2017-11-21>Document aligned with SP08 release

CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

Table of ContentsTable of Contents

1Overview .................................................................................................................................. 11

2Architectural Overview .......................................................................................................... 12

2.1Component Description ....................................................................................................................... 12

2.1.1Critical API Processing Components ................................................................................. 12

2.1.2Non-Critical API Processing Components ......................................................................... 13

3About Planets, Regions, Pods, Organizations, Environments and Virtual Hosts ............... 14

3.1About Planets ........................................................................................................................................ 15

3.2About Regions ....................................................................................................................................... 15

3.3About Pods ............................................................................................................................................ 17

3.4About Organizations.............................................................................................................................19

3.5About Environments............................................................................................................................ 20

3.6About Virtual Hosts .............................................................................................................................. 21

3.7Creating your first organization, environment, and virtual host ..................................................... 22

4Installation File System .........................................................................................................23

4.1Installation Directory ........................................................................................................................... 23

4.2File System Structure.......................................................................................................................... 23

4.3Important Data to Remember from the Installation Process .......................................................... 24

5How to Configure SAP API Management Edge ....................................................................25

5.1How to use .properties files ................................................................................................................ 25

5.2Location of .properties files ................................................................................................................ 26

5.3Determining the current value of a token .......................................................................................... 26

5.4Setting tokens in .properties files....................................................................................................... 27

5.5Setting a token that takes multiple values ........................................................................................ 27

5.6Locating a token .................................................................................................................................. 28

5.7Setting a token that is currently commented out ............................................................................. 28

6Using the apigee-adminapi.sh utility ................................................................................... 30

6.1Installing apigee-adminapi.sh ............................................................................................................. 30

6.2apigee-adminapi.sh syntax ................................................................................................................. 30

6.3Setting parameters using command-line switches and environment variables ............................ 31

6.4Passing a file to the apigee-adminapi.sh utility ................................................................................. 32

6.5Displaying debug and API information .............................................................................................. 33

7Post Installation Tasks ..........................................................................................................35

7.1Reset Passwords ................................................................................................................................. 35

7.1.1Resetting SAP API Management Edge Password ............................................................ 35

7.1.2Resetting SAP API Management BaaS Passwords .......................................................... 43

7.1.3Managing the Default LDAP Password Policy for API Management .............................. 44

SAP API Management, On-Premise Edition

Table of Contents CUSTOMER

© 2014 SAP SE or an SAP affiliate company.

7.2.1Customizing SAP API Management Email Templates ..................................................... 48

7.2.2Configuring the SAP API Management Edge SMTP server .............................................49

7.2.3Configuring SMTP for the SAP API Management BaaS SMTP Server ...........................50

7.2.4Set the expiration time for user activation links in activation emails .............................50

7.3Configure Logging ................................................................................................................................ 51

7.3.1Setting the log level for a SAP API Management Edge component ................................ 51

7.3.2Setting log file location ........................................................................................................ 52

7.4Configure the SAP API Management Edge UI ................................................................................... 52

7.4.1Setting the Session Timeout in the SAP API Management Edge UI ............................... 52

7.4.2Setting the port number of the SAP API Management Edge UI ...................................... 53

7.4.3Enabling the consent banner .............................................................................................. 53

7.4.4Setting the URL of the Developer Services portal ............................................................ 54

7.4.5Allowing the SAP API Management UI Access to Local IP addresses ............................ 55

7.4.6Allow custom reports longer than 14 days in the SAP API Management Edge UI ......... 57

7.4.7Setting the password hint text in the SAP API Management Edge UI ............................ 57

7.4.8Configure rules used to auto generate SAP API Management Edge UI passwords ...... 58

7.4.9Configure the SAP API Management Edge UI to store session information in memory

7.5Configure Router and Message Processor ....................................................................................... 60

7.5.1Enabling/Disabling Server (Message Processor/Router) Reachability ....................... 60

7.5.2Setting HTTP request/response header limits ................................................................ 61

7.5.3Configuring the Router to retry connections to a Message Processor .......................... 62

7.5.4Configure Forward Proxying from SAP API Management Edge to a Backend Server ..64

7.5.5Set the message size limit in the Router or Message Processor .................................... 65