API Server Home

The API Development site teaches Cortex java developers how to create new resources, modify out-of-the-box resource functionality, adjust Cortex run-time configurations, and much more. Here you can find code samples, configuration details, and architecture overviews that can make the job of customizing Cortex easier.

Elastic Path Developers Portal

Getting Started

Introduction to Helix

An introduction to Helix, the new programming model for the Cortex API, and how it can work for you.

The Helix Development Process

An overview of the development process of creating a resource in the Helix programming model for Cortex.

Tutorials

Step-by-step tutorials for common development tasks, with working example code and exercises.

Architecture and Design

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

API Definition

How to define an API's resources, entities, and relationships in the Helix programming model.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Identifiers

Creating and using resource identifiers.

Resource Prototypes

Creating and using resource prototypes.

Configuring Prototypes

Configuring a resource prototype's local dependency injections, OSGi service building, and permissions.

Dynamic Fields

How to use dynamically generated properties in your resources.

Extending Helix Resources

Learn how to extend an exiting Helix resource to add new functionality.

Data Injectors

Learn about the different kinds of data injectors Cortex provides.

Advisors

Learn about advisors, a prototype that can provide advice and blocking functionality to your resources.

Structured Error Messages

Learn about how structured error messages are generated in Commerce Engine and surfaced to Cortex, and how to customize them to your needs.

Working with Mixed Models

Learn about the differences between Helix programming model resources and legacy resources, and how to interact with both.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Caching

Describes to use Cortex caching capabilities: domain object caching and request-scoped caching.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Configuring JNDI Services

Describes how to configure JNDI services used by Cortex.

References

Pattern Library

Working examples of common implementation patterns for Helix programming model resources.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

RxJava

Explains the subset of RxJava types used by Helix programming model resources.

Legacy Implementation Strategies

Describes common implementation strategies for working with legacy resources.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Introduction to Helix

An introduction to Helix, the new programming model for the Cortex API, and how it can work for you.

The Helix Development Process

An overview of the development process of creating a resource in the Helix programming model for Cortex.

Tutorials

Step-by-step tutorials for common development tasks, with working example code and exercises.

Architecture and Design

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

API Definition

How to define an API's resources, entities, and relationships in the Helix programming model.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Identifiers

Creating and using resource identifiers.

Resource Prototypes

Creating and using resource prototypes.

Configuring Prototypes

Configuring a resource prototype's local dependency injections, OSGi service building, and permissions.

Dynamic Fields

How to use dynamically generated properties in your resources.

Extending Helix Resources

Learn how to extend an exiting Helix resource to add new functionality.

Data Injectors

Learn about the different kinds of data injectors Cortex provides.

Advisors

Learn about advisors, a prototype that can provide advice and blocking functionality to your resources.

Structured Error Messages

Learn about how structured error messages are generated in Commerce Engine and surfaced to Cortex, and how to customize them to your needs.

Working with Mixed Models

Learn about the differences between Helix programming model resources and legacy resources, and how to interact with both.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Caching

Describes to use Cortex caching capabilities: domain object caching and request-scoped caching.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Configuring JNDI Services

Describes how to configure JNDI services used by Cortex.

References

Pattern Library

Working examples of common implementation patterns for Helix programming model resources.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

RxJava

Explains the subset of RxJava types used by Helix programming model resources.

Legacy Implementation Strategies

Describes common implementation strategies for working with legacy resources.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Writing Your First Resource

Learn the steps to create your first Cortex resource, which will return a simple string.

Adding Links to Your Resource

Learn how to update an existing resource to link to your new resource.

Enhancing Resource to Read From Other (RFO)

Learn how to customize a resource to read data from another resource.

Interfacing With Commerce Engine

Learn how to call down into Commerce Engine to initiate e-commerce operations.

Architecture Overview

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Override a Resource Integration with an OSGi Fragment

Describes how to create an OSGi bundle fragment to override functionality within a Commerce Engine resource integration

Caching

Describes to use Cortex caching capabilities: domain object caching and request-scoped caching.

Configuring JNDI Services

Describes how to configure JNDI services used by Cortex.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Writing Your First Resource

Learn the steps to create your first Cortex resource, which will return a simple string.

Adding Links to Your Resource

Learn how to update an existing resource to link to your new resource.

Enhancing Resource to Read From Other (RFO)

Learn how to customize a resource to read data from another resource.

Interfacing With Commerce Engine

Learn how to call down into Commerce Engine to initiate e-commerce operations.

Architecture Overview

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Override a Resource Integration with an OSGi Fragment

Describes how to create an OSGi bundle fragment to override functionality within a Commerce Engine resource integration

Caching

Describes to use Cortex caching capabilities: domain object caching and request-scoped caching.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Writing Your First Resource

Learn the steps to create your first Cortex resource, which will return a simple string.

Adding Links to Your Resource

Learn how to update an existing resource to link to your new resource.

Enhancing Resource to Read From Other (RFO)

Learn how to customize a resource to read data from another resource.

Architecture Overview

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Override a Resource Integration with an OSGi Fragment

Describes how to create an OSGi bundle fragment to override functionality within a Commerce Engine resource integration

Caching

Describes to use Cortex caching capabilities: domain object caching and request-scoped caching.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Writing Your First Resource

Learn the steps to create your first Cortex resource, which will return a simple string.

Adding Links to Your Resource

Learn how to update an existing resource to link to your new resource.

Enhancing Resource to Read From Other (RFO)

Learn how to customize a resource to read data from another resource.

Architecture Overview

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Override a Resource Integration with an OSGi Fragment

Describes how to create an OSGi bundle fragment to override functionality within a Commerce Engine resource integration

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Writing Your First Resource

Learn the steps to create your first Cortex resource, which will return a simple string.

Adding Links to Your Resource

Learn how to update an existing resource to link to your new resource.

Architecture Overview

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Tutorials

Cortex customization tutorials, which include creating a resource integration, adding third party jars to Cortex, and much more.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Getting Started

Writing Your First Resource

Learn the steps to create your first Cortex resource, which will return a simple string.

Adding Links to Your Resource

Learn how to update an existing resource to link to your new resource.

Architecture Overview

Introduction

Overview of Cortex architecture and the framework's layers.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Introduction

Lists the programming guide's contents.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Tutorials

Cortex customization tutorials, which include creating a resource integration, adding third party jars to Cortex, and much more.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

System Configuration Guide

Runtime Configurations

How to configure Cortex during runtime using config files or Apache Felix Web Console.

Architecture Overview

Introduction

Cortex architecture and the different layers in the framework.

Call Stack

How the architectural layers work to process a single call to Cortex and return the result back to the client application.

Programming Guide

Getting Started

Create your first Cortex resource to return a simple string.

Resource Classes and Annotations

Describes the different types of Cortex resources, their capabilities, classes, and annotations.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Cortex Implementation Patterns

Describes the common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Tutorials

Cortex customization tutorials, which include creating a resource integration, adding third party jars to Cortex, and much more.

Security Configuration Guide

Introduction

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Authentication

How Cortex could use OAuth2.0 to provide client application authentication.

Cortex Authorization

How Cortex uses Apache Shiro, a role-based access control framework, to provide access control to Cortex resources.

Framework Extension Guide

Customizing Personalization

How Cortex personalization--an e-commerce feature for offering different pricing, promotions, and content based on a shopper's traits--works and can be customized.

Personalization Configuration

How to configure Cortex shopper traits.

Installation and Configuration Guide

Setting up your Developer Environment

Overview of the software you will install to set up a dev environment.

Installing Software

Instructions on how to install the software required for a developer environment.

Configuring for Development

Instructions on the configurations required on your local computer to set up your developer environment.

Populating Cortex API Database

Instructions for populating a Cortex API database.

Generate Cortex Projects

Instructions on how to generate the Cortex projects to setup a development environment.

Setting up Cortex Studio Outside of Eclipse

Instructions for setting up Cortex and Cortex Studio outside of Eclipse.

Setting up Cortex In Eclipse

Instructions for setting up Cortex in Eclipse.

Tutorials

Installing the Cortex API Tutorials

Instructions for how to setup and run the Cortex tutorials on your local developer environment.

Tutorial 1 - Hello World

Describes how the HelloWorld Cortex tutorial components work to returns a simple string, "Hello World."

Tutorials 2 - Extension Profile

Describes how the ExtensionProfile tutorial components work to extend the out-of-the-box profiles resource.

Tutorial 3 - CoreLookup

Describes how the CoreLookup tutorial components work to retrieve data through the commerce engine.

Tutorial 4 - StopCondition

Describes how the StopCondition tutorial components work to add a needInfo link to a resource.

Tutorial 5 - Creating a Resource Integration

Describes how to create a resource integration and swap it with an existing resource integration.

Tutorial 6 - Adding third party jars to Cortex

Describes how to add third party jars as OSGi dependencies to Cortex.

Tutoral 7 - Integrating Cortex with an Identity Management System

Describes a potential way to swap a custom Identity Management System (IdM) with the one supplied in Cortex out of the box.

Cortex Implementation Patterns

Describes the common Cortex implementation patterns that can help you understand how to customize Cortex given your business needs.

Tutorial 9 - Resource Integration Fragment Override

Describes how to create an OSGi bundle fragment to override functionality within a Commerce Engine resource integration.

Programming Guide

Release Structure and Source Code Organization

Shows the package structure of the Cortex source zip.

API and Core Terminology Difference

Describes important terminology differences between Commerce Engine and Cortex.

Architecture Overview

Cortex architecture and the different layers in the framework.

Security Configuration Guide

Introduces Cortex security features, such as OAuth2.0 and Apache Shiro.

Cortex Web Application POMs

An overview of the Cortex Web Application POM structure.

Cortex Studio

Describes an overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Creating test payment methods

Describes how to enable the test credit card resource, so you can test credit cards and token payment methods in Cortex.

Logging

Describes the Cortex Logback implementation, which is a configurable logging utility for outputting messages.

Maven

Describes an overview of Maven, available profiles and commands.

Resource Development Guide

Important information for creating Cortex resources, such as how resources work, steps to create them, interfacing with Commerce Engine, and ID encoding.

Deployment Guide

Deployment Architecture

A sample deployment architecture.

System Requirements

Lists the components supported for deploying Elastic Path commerce in production.

Deploying the Elastic Path Web Applications

Guidelines for deploying the Elastic Path web applications on Tomcat 6, Tomcat 7, and Weblogic 11g.

System Configuration

Configuration properties effecting Cortex configurations.