DigitMarket™ API Manager documentation
DigitMarket™ API Manager 3.4 - Docs
1. Introduction
1.1. Introduction
1.1.1. DigitMarket™ API Manager Features
1.1.1.1. Publisher Portal Features
1.1.1.2. Developer Portal Features
1.1.1.3. Gateway Features
1.1.2. Architectural Overview
1.1.3. Key Concepts
1.1.3.1. Publisher Portal
1.1.3.2. API
1.1.3.3. What is a Proxy Endpoint and Real Endpoint
1.1.3.4. API Pack
1.1.3.5. API Monetization - Usage Plans
1.1.3.6. Gateway
1.1.3.7. Authentication
1.1.3.8. XSS safety
1.1.3.9. LDAP support
1.1.3.10. Usage Limits
1.1.3.11. Concurrency Limit
1.1.3.12. Usage Policy Library
1.1.3.13. Transformations
1.1.3.14. Data Recording
1.1.3.15. Life cycle of Artifacts and Approval Workflows
1.1.3.16. Gateway Synchronization
1.1.3.17. User Roles and Portal Visibility
1.1.3.18. Search
1.1.3.19. Configurable Workflows
1.1.3.20. Email Notifications
1.1.3.21. Exporting and Importing Data
1.1.3.22. Developer Portal
1.2. Documentation
1.2.1. How to use this Documentation
1.2.2. Document Conventions
1.2.3. Definitions
2. What’s New!
3. Publisher Portal
3.1. Publisher Portal - Overview
3.2. Getting Started
3.2.1. Log in to the Publisher Portal
3.2.1.1. Login Case-sensitivity
3.2.2. User Roles and Access
3.2.3. Change your User Profile
3.2.4. User Login Issues
3.2.4.1. Forgot Password
3.2.4.2. Unlock User Account
3.2.5. Password Expiry Notification
3.2.6. Changing Password after Expiry
3.2.7. Password Policy on Change/Reset Password
3.2.8. Customized Login Failure Messages
3.3. Create and Configure a Backend Server
3.3.1. Add a Backend Server
3.3.2. Edit a Backend Server
3.3.3. Delete a Backend Server
3.3.4. View APIs on a Backend Server
3.4. Create an API
3.4.1. Assign a Name and Type to an API
3.5. Edit an API
3.5.1. Add Descriptions to an API
3.5.2. Add API Resources
3.5.2.1. Add Resources to a REST API
3.5.2.2. Add Operations to a SOAP API
3.5.3. Edit API Resources
3.5.3.1. WSDL Re-upload
3.5.3.2. Swagger Re-upload
3.5.3.3. Edit a REST API Resource
3.5.4. Delete Resources from an API
3.5.5. Schema Validations
3.5.6. Manage Transformations
3.5.6.1. REST Transformation
3.5.6.2. SOAP Transformation
3.5.6.3. Protocol Conversion
3.5.6.4. Encryption and Decryption
3.5.6.5. Payload Conversion
3.5.7. Manage Data Recording
3.5.8. Configure Endpoints
3.5.9. Add Advanced Configurations
3.5.9.1. Setting Request Timeout
3.5.9.2. Setting Fault configuration
3.5.9.3. Setting Response Cache
3.5.10. Add API Versions
3.5.10.1. Switch API Versions
3.5.11. Manage Visibility of an API
3.5.12. Edit an API Name
3.5.13. Send an API for Approval
3.5.14. Deprecate an API
3.5.15. Retire an API
3.5.16. Open an Approved or Published API for Editing
3.5.17. Discard Changes after opening an API for Editing
3.5.18. Search an API
3.6. Export and Import APIs
3.7. Delete an API
3.8. Create an API Pack
3.8.1. Assign a Name and Monetization Strategy to an API Pack
3.9. Edit an API Pack
3.9.1. Add Descriptions to an API Pack
3.9.2. Add Resources to an API Pack
3.9.3. Delete Resources or Operations from an API Pack
3.9.4. Add Usage Plans to an API Pack
3.9.4.1. Create a Usage Plan
3.9.4.2. Manage Visibility of a Usage Plan
3.9.4.3. Edit a Usage Plan Name
3.9.4.4. Send a Usage Plan for Approval
3.9.4.5. Deprecate a Usage Plan
3.9.4.6. Retire a Usage Plan
3.9.4.7. Open an Approved or Published Usage Plan for Editing
3.9.4.8. Discard Changes after opening a Usage Plan for Editing
3.9.4.9. Modify Usage Plan Display Order
3.9.4.10. Delete a Usage Plan
3.9.5. Attach Documentation to an API Pack
3.9.6. Brand an API Pack for Developer portal
3.9.7. Manage Visibility of an API Pack
3.9.8. Edit an API Pack Name
3.9.9. Send an API Pack for Publishing
3.9.10. Open a Published API Pack for Editing
3.9.11. Search an API Pack
3.10. Export and Import API Packs
3.11. Delete an API Pack
3.12. Create a Named Usage Policy
3.12.1. Add a Named Usage Policy
3.13. Edit a Named Usage Policy
3.13.1. Edit a Named Usage Policy
3.13.2. Edit a Usage Policy Name
3.13.3. Send a Named Usage Policy for Approval
3.13.4. Submit a Usage Policy for Deprecation
3.13.5. Submit a Usage Policy for Retirement
3.13.6. Open an Approved or Published Usage Policy for Editing
3.13.7. Discard Changes after opening a Usage Policy for Editing
3.13.8. Search a Usage Policy
3.14. Export and Import Usage Policies
3.15. Delete a Named Usage Policy
3.16. Manage Approvals
3.16.1. View details of an Artifact
3.16.2. Approve an Artifact
3.16.3. Reject an Artifact
3.17. Configuring Gateway
3.17.1. Microgateway
3.17.1.1. Add a New Gateway
3.17.1.2. Edit an Existing Gateway
3.17.1.3. Delete a Gateway
3.17.1.4. Instance
3.17.1.5. API
3.17.1.6. Plan
3.17.1.7. Subscription
3.17.1.8. Usage Policy
3.17.1.9. Backend Point
3.17.1.10. Setting the Fault Configuration at each Gateway
3.18. Gateway Sync
3.18.1. Synchronize Changes
3.18.1.1. Synchronize Changes to Production Gateways
3.18.2. View Synchronization History and Rollback
3.19. Manage Publisher Users and Groups
3.19.1. Manage Publisher Groups
3.19.2. Manage Publisher Users
3.20. Manage Developer Users and Groups
3.20.1. Manage Developer Organizations
3.20.2. Manage Developer Groups
3.20.3. Manage Developer Users
3.21. Common Developer Portal URL
3.22. Default Email ID Allocation for LDAP Users
3.23. Email ID and Role Validation
3.24. Manage Access Tokens
3.24.1. Revoke an Access token
3.25. Manage Developer Applications
3.26. Customize Developer Portal
3.26.1. Developer Portal Content Management
3.26.2. Manage API Pack Categories
3.26.3. Manage Discussion Forum
3.27. Configure Subscription-level Settings
3.27.1. Propagate a Subscription
3.27.2. Add a Subscription
3.27.3. Configure a Subscription
3.27.3.1. Configure Security Policy Resources/Operations
3.27.3.2. Configure MCT Limit
3.27.3.3. Filter IPs
3.27.3.4. Map Subscription to Gateway
3.27.3.5. Change Subscription Expiration Date
3.27.3.6. Set Fault Configuration
3.27.3.7. Configure Authentication Value
3.27.3.8. Configure Usage Policy
3.27.3.9. View Applications details
3.28. Statistics and Analytics
3.29. Theme
3.30. Search Logs
3.31. Set Global Configurations
3.31.1. General Settings
3.31.1.1. Configure Approval Workflows
3.31.2. Email configuration
3.31.3. User Management
3.31.4. LDAP Integration
3.31.5. Developer Common Login
3.31.6. Input Field Validation
3.31.7. Other Settings
3.31.8. Fault Configuration
3.31.8.1. Setting Fault Configuration for REST APIs
3.31.8.2. Setting Fault Configuration for SOAP APIs
3.31.9. Macros for Fault Structure
3.31.10. Configuration Scenarios
3.32. Export and Import Data
3.33. Email Notifications
4. Developer Portal
4.1. Developer Portal - Overview
4.2. Get Started
4.2.1. Developer Sign Up
4.2.2. Log in to the Developer Portal
4.2.3. To log out of
DigitMarket™ API Manager
Developer portal:
4.2.4. Modify Profile
4.3. Browse and Search API Packs
4.4. Manage Applications
4.4.1. Add an Application
4.4.2. Edit an Application
4.4.3. The Application Workflow
4.4.4. Deactivate an Application
4.4.5. Reactivate an Application
4.4.6. View Application Details
4.4.7. Generate an Access Token
4.4.7.1. Revoke an access token
4.4.8. Filter Application view
4.5. Manage Subscriptions
4.5.1. Subscribe to a Plan
4.5.2. View Subscriptions and filter Subscriptions view
4.5.2.1. View Subscription Details
4.6. View API Pack Documentation
4.6.1. View Sample Data
4.7. Test using Sandbox
4.8. Add Ratings and Reviews for API Packs
4.9. Using the Discussion Forum
4.10. Manage Bookmarks
4.10.1. Create a Bookmark
4.10.2. View Bookmarks
4.10.3. Delete a Bookmark
4.11. Statistics and Analytics
5. Sandbox
5.1. Configuring Sandbox Gateway
5.2. Backend Point
5.3. Configuring Sandbox Backend
5.4. Propagating Backend Endpoints to SandBox Gateway
5.5. Configuring API Endpoint for Sandbox
5.6. Propagating APIs to Sandbox Gateways
5.7. Configuring API Pack for Sandbox
5.7.1. Add Resources from Approved or Published REST APIs to a REST API Pack
5.7.2. View and modify a Sandbox Plan
5.7.3. Send a Sandbox Plan for Approval
5.7.4. Send an API Pack for Approval for Sandbox
5.8. Propagating Sandbox Plans to SandBox Gateways
5.9. Propagating Usage Policies of a Sandbox plan to SandBox Gateway
5.10. Edit an Existing Gateway
5.11. Delete a Gateway
5.12. Instance
5.12.1. Add an New Instance
5.12.2. Edit an Existing Instance
5.12.3. Delete an Instance
5.13. API
5.14. Plan
5.15. Subscription
5.16. Usage Policy
5.17. Propagating SandBox Gateway
5.18. Test using Sandbox
6. Gateway
6.1. Consuming APIs through the Gateway
6.2. Protection
6.3. SOAP attachments
6.3.1. Referenced Attachments
6.3.1.1. MTOM attachments
6.3.1.2. SWA and swaRef attachments
6.3.2. Unreferenced Attachments
6.4. WSDL Download
6.5. Charset and Emoji support
6.5.1. Charset support
6.5.2. Emoji support
7. Gateway OAuth APIs
7.1. Generate an access token
7.2. Validate an access token
7.3. Revoke an access token
7.4. Get the list of all the scopes for an application
DigitMarket™ API Manager documentation
»
Search
Please activate JavaScript to enable the search functionality.