As the name suggests, key-based APIs follow the Standard Key Interface (SKI) pattern. SKI HTTP requests require a key parameter that is tied to an authorized IP address. System administrators can manage these in their RealCADENCE control panel.
The basic request implementation follows this pattern:
https:// [host] / [operation] / [context] / [item-type] ? [parameters]
In all cases with SKI APIs, one parameter will be the key and another will be the output format desired: json, skinny(unwrapped JSON) or xml.
The key should be added to each request as a HTTP Header:
E.g.
x-api-key: 987654321
API Categories