Pre-Con Ed: CA API Developer Portal: Policy Writing for the Portal Using the New Context Variables and API Key Custom Fields
•Download as PPTX, PDF•
4 likes•533 views
This document discusses using context variables and custom fields in CA API Developer Portal policy writing. It describes how portal policy templates and custom fields allow additional input that can be leveraged by gateway policies. The presentation includes an example of a policy template, discusses typical use cases, and demonstrates a policy that uses a custom field to variably set quotas on HTTP methods and restrict partner access.
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Similar to Pre-Con Ed: CA API Developer Portal: Policy Writing for the Portal Using the New Context Variables and API Key Custom Fields
Similar to Pre-Con Ed: CA API Developer Portal: Policy Writing for the Portal Using the New Context Variables and API Key Custom Fields (20)
More from CA Technologies
More from CA Technologies (20)
Recently uploaded
Recently uploaded (20)
Pre-Con Ed: CA API Developer Portal: Policy Writing for the Portal Using the New Context Variables and API Key Custom Fields
- 1. CA API Developer Portal: Policy Writing for the Portal Using Context Variables and Custom Fields Jay Bagtas Principal Software Engineer CA Technologies DO3X40E DEVOPS
- 2. 5 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD © 2016 CA. All rights reserved. All trademarks referenced herein belong to their respective companies. The content provided in this CA World 2016 presentation is intended for informational purposes only and does not form any type of warranty. The information provided by a CA partner and/or CA customer has not been reviewed for accuracy by CA. For Informational Purposes Only Terms of this Presentation
- 3. 6 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Abstract CA API Management Policy flexibility is what allows customers to create solutions and modify them easily over time as your business changes. In this course, we will look at how to write Policy to leverage Context Variables, Custom Fields and Policy Templates to create solutions for real-world use cases. Jay Bagtas CA Technologies Principal Software Engineer
- 4. 7 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Agenda INTRODUCTION GATEWAY POLICY Q&A PORTAL POLICY TEMPLATES PORTAL CUSTOM FIELDS DEMO 1 2 3 4 5 6
- 5. 8 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Introduction
- 6. 9 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Policy Entities Encapsulated Assertion Policy/Policy Fragment Assertions Context Variables
- 7. 10 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Policy Writing Turing-complete Supports branching, looping Extensible but comes with numerous Assertions Easy to learn, hard to master
- 8. 11 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Portal and the Gateway Portal allows publishing of APIs managed by the Gateway Policy Templates and Custom Fields are Portal features that allow additional input into these APIs – Portal users define the what – Gateway admins define how input used at API runtime
- 9. 12 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Example Policy Template/Encapsulated Assertion
- 10. 13 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Custom Fields Portal supports API & API Key custom fields Metadata that can be added to an API & API Key Custom Fields can be setup as text fields or single-select dropdowns Custom Field values are specified at API & API Key creation
- 11. 14 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Example API Custom Field/Service Properties Sub-head
- 12. 15 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Example Application Custom Field
- 13. 16 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Typical Use Cases Authentication Authorization Routing Rate limiting API Protection Metadata extension for APIs and Applications
- 14. 17 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Let’s Do an Exercise Problem: Need to variably set quotas on specific HTTP Methods for an API Problem part 2: Partners do not get access to certain HTTP methods for an API
- 15. 18 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Demo
- 16. 19 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD What Did We Do? Created an Policy Template/Encapsulated Assertion Exposed it to the Portal Created an API that used it and an Application to consume it Added a API Custom Field for additional control Added an Application Custom Field for differentiated control
- 17. 20 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Recommended Sessions SESSION # TITLE DATE/TIME DO3X51E 11/14/2016 at 2:00 PM DO3T11T Tech Talk: CA API Gateway: Deploying Docker Container Gateways 11/16/2016 at 11:30 AM DO3T12T Tech Talk: SaaS Portal: Advantages of deploying your developer portal in SaaS vs an on-premises solution 11/16/2016 at 12:15 PM Pre-Con Ed: Workshop on Policy Creation, Management and Support for OAuth and OIDC
- 18. 21 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Must See Demos Booth: API Management SaaS Developer Products Area Main Show Floor CA API Developer Portal Developer Products Area Main Show Floor Booth:
- 19. 22 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Questions?
- 20. 23 © 2016 CA. ALL RIGHTS RESERVED.@CAWORLD #CAWORLD Thank you. Stay connected at communities.ca.com
Editor's Notes
- As you build out your presentation, here are a few dos and don’ts.
- Portal and the Gateway
- Policy defines the rules (assertions) the Gateway enforces Applied at runtime allowing supreme flexibility Has its own learning curve but plenty of benefits The Portal has features that allow users to define additional configuration actionable via Policy Policy not code = flexibility Code is rigid and hard to change Policy is flexible, can be done on the fly, doesn’t need to be re-compiled
- Assertions Define what a Policy does and are the base building block Policy Fragment Re-usable piece of policy reference-able within other Policies Encapsulated Assertion Self-contained Policy based on a Policy Fragment that accepts inputs and generates outputs Context Variables Variables reference-able within Policy
- Policy Templates are Encapsulated Assertions specifically exposed to the Portal Allows publishing of APIs that reference an Encapsulated Assertion Typically encapsulate IT and Security rules Ex. SSL requirement, two-factor authentication Lets API Owners provide inputs specific to their API
- API Custom Fields are created as Service Properties on the Gateway Reference-able in Policy via context variable: ${service.property.NAME} Viewable in Policy Manager via Published Service Properties dialogue
- Application Custom Fields are tied specifically to the API Key Stored as JSON
- Populate with sessions