Jump To Close Expand all Collapse all Table of contents Using the Developer Portal I. API documentation Expand section "I. API documentation" Collapse section "I. API documentation" 1. Adding specifications to 3scale Expand section "1. Adding specifications to 3scale" Collapse section "1. Adding specifications to 3scale" 1.1. Navigate to service specifications in ActiveDocs 1.2. Create a service specification 1.3. Working with your first ActiveDoc 2. Create an OAS spec Expand section "2. Create an OAS spec" Collapse section "2. Create an OAS spec" 2.1. About OpenAPI Specification (OAS) 2.2. 3scale ActiveDocs and OAS 2.3. Creating the specification of your API Expand section "2.3. Creating the specification of your API" Collapse section "2.3. Creating the specification of your API" 2.3.1. Learning by example: the Petstore API 2.3.2. More on the OAS specification Expand section "2.3.2. More on the OAS specification" Collapse section "2.3.2. More on the OAS specification" 2.3.2.1. OAS object 2.3.2.2. Info object 2.3.2.3. Paths object 2.3.3. Useful tools Expand section "2.3.3. Useful tools" Collapse section "2.3.3. Useful tools" 2.3.3.1. Extension to the OAS specification: auto-fill of API keys 3. ActiveDocs & OAuth Expand section "3. ActiveDocs & OAuth" Collapse section "3. ActiveDocs & OAuth" 3.1. Prerequisites 3.2. Client credentials and resource owner flows 4. Publish ActiveDocs in the Developer Portal 5. Upgrade Swagger UI 2.1.3 TO 2.2.10 II. API versioning Expand section "II. API versioning" Collapse section "II. API versioning" 6. API Versioning Expand section "6. API Versioning" Collapse section "6. API Versioning" 6.1. Goal 6.2. Prerequisites 6.3. URL versioning 6.4. Endpoint versioning 6.5. Custom header versioning III. API authentication Expand section "III. API authentication" Collapse section "III. API authentication" 7. Authentication patterns Expand section "7. Authentication patterns" Collapse section "7. Authentication patterns" 7.1. Supported authentication patterns 7.2. Setting up authentication patterns Expand section "7.2. Setting up authentication patterns" Collapse section "7.2. Setting up authentication patterns" 7.2.1. Select the authentication mode for your service 7.2.2. Select the Authentication mode you want to use 7.2.3. Ensure your API accepts the correct types of credentials 7.2.4. Create an application to test credentials 7.3. Standard authentication patterns Expand section "7.3. Standard authentication patterns" Collapse section "7.3. Standard authentication patterns" 7.3.1. API key 7.3.2. App_ID and App_Key pair 7.3.3. OpenID Connect 7.4. Referrer filtering 8. OpenID Connect integration Expand section "8. OpenID Connect integration" Collapse section "8. OpenID Connect integration" 8.1. JWT verification and parsing by APIcast 8.2. Client credentials synchronization by zync-que 8.3. Configure Red Hat Single Sign-On integration Expand section "8.3. Configure Red Hat Single Sign-On integration" Collapse section "8.3. Configure Red Hat Single Sign-On integration" 8.3.1. Configuring zync-que to use custom CA certificates 8.3.2. Configure Red Hat Single Sign-On 8.3.3. Configure 3scale 8.4. Configure HTTP integration with third-party Identity Providers Expand section "8.4. Configure HTTP integration with third-party Identity Providers" Collapse section "8.4. Configure HTTP integration with third-party Identity Providers" 8.4.1. Pre-requisites 8.4.2. Procedure 8.4.3. Zync REST API example Expand section "8.4.3. Zync REST API example" Collapse section "8.4.3. Zync REST API example" 8.4.3.1. Prerequisites 8.4.3.2. Creating, updating and deleting clients 8.4.3.3. Payload 8.4.3.4. Using OAuth2 authentication 8.5. OAuth 2.0 supported flows Expand section "8.5. OAuth 2.0 supported flows" Collapse section "8.5. OAuth 2.0 supported flows" 8.5.1. How OAuth 2.0 supported flows work 8.5.2. Configuring OAuth 2.0 supported flows 8.6. Test the integration Expand section "8.6. Test the integration" Collapse section "8.6. Test the integration" 8.6.1. Test the client synchronization 8.6.2. Test the API authorization flow 8.7. Example of the integration IV. OpenAPI Specification (OAS) Expand section "IV. OpenAPI Specification (OAS)" Collapse section "IV. OpenAPI Specification (OAS)" 9. Creating a New Service Based on OpenAPI Specification (OAS) Expand section "9. Creating a New Service Based on OpenAPI Specification (OAS)" Collapse section "9. Creating a New Service Based on OpenAPI Specification (OAS)" 9.1. Introduction 9.2. Prerequisites 9.3. Features of OpenAPI Specification 9.4. Using OpenAPI Specification Expand section "9.4. Using OpenAPI Specification" Collapse section "9.4. Using OpenAPI Specification" 9.4.1. Detecting OpenAPI definition from the filename path 9.4.2. Detecting OpenAPI definition from a URL 9.4.3. Detecting OpenAPI definition from stdin Legal Notice Settings Close Language: 日本語 English Language: 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 日本語 English Language: 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Part I. API documentation Previous Next
