Interactive Self-Service Support for APIs on API Platforms

With Policy Checkpoints from Nomos

“API Platform” Companies

• Companies put APIs on API Platforms in order to

– Control access to the API (security etc)

– Publicise, provide easy access to, and ‘monetize’ their APIs

– Get analytics on API usage (e.g. what customers use it most)

API Platforms

What Nomos does

• Provides ‘interactive support’ / sandbox capability on API Platforms

• By adding in ‘policy checkpoints’ for APIs

• API users get feedback on how to use the API correctly : self-service support

Example Policy Checks

Apigee Example

Policy Checkpoint for TMForumProductOrder Telecoms REST API, JSON

API Proxy on ApigeeAPI Implementation hosted on JElastic

Policy Checkpoint built with RuleX from Nomos

Using Chrome REST Console 4.0.2

API Proxyon Apigee

TMForum Product Order API

Implementation

2. Apply Policy

1. Order Product

3. Order Product

API Users

Product OrderPolicy Checkpoint

The Flow

Read the blogs:http://nomos-software.com/blog/apis-hackathon-and-apigee-integration

http://nomos-software.com/blog/apis-and-hackathoning-again

URI: http://nomos1-test.apigee.net/v1/nomosrulexvalidationservice2

Method: POST

Content Type: application/json

Content Type: CorrectProduct order request

Submit Correct Order – REST Client

Apigee Trace for Correct Order

Request received from client

Policy checkpointexecuted

Response sent to Jelastic service(no screenshot of response included)

Product Order created

Response received from Jelastic

Final responsesent to client

Response for Correct Order – REST ClientResponse shows the product order that was created

URI: http://nomos1-test.apigee.net/v1/nomosrulexvalidationservice2

Method: POST

Content Type: application/json

Content Type: An incorrectProduct order request

Submit Incorrect Order

Trace for Incorrect Order

Request received from client

Policy checkpointexecuted : Fails checkpoint. Transaction aborted

Response frompolicy checkpointsent to client

Response for Incorrect OrderResponse gives details of errors in the request, including exact line number of error

Learn more about RuleX?

Integrate with another API Platform?

Contact usnomos-software.com+353 – 21 - 4928945

@nomossoftware