openapi: 3.0.3
info:
title: Real-Time-Interception API
description: API for validating user's request on client's server side source
version: 1.0.0
servers:
- url: 'https://obstaging.cheqzone.com'
paths:
/v1/realtime-interception:
post:
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
required:
- ApiKey
- TagHash
- Method
- ClientIP
- RequestURL
- HeaderNames
- Host
- EventType
properties:
ApiKey:
type: string
description: The API key provided to the customer
example: 62fdc812-be58-492f-9417-66a1f22b4daa
TagHash:
type: string
description: The Tag Hash of the javascript provided to the customer
example: bebceff7cb66cf7232478306cba94d8e
ResourceType:
type: string
description: The Content-Type which will be served to the client
example: application/json
default: text/html
CheqCookie:
type: string
description: _cheq_rti cookie assigned to the client
example: >-
_cheq_rti=4hKcXz8Fnay2VoZrgeU3+t/o67c=17WIjo3f/THP8TI5enbYKhAazwduiQRJywB+t4lXfVMseFutqu4YAD73q6Verht1nA9tsT1//7Q6jzjjL0GUAmkKGFSmkpkjgrmoxms=;
Expires=Tue, 27 Dec 2022 09:36:44 GMT; path=/
default: Required if exists in visitor's request
Method:
type: string
description: HTTP Request Method from the client (GET/POST/OPTIONS)
example: GET
ClientIP:
type: string
description: IP address of the client (trusted)
example: 208.34.223.183
RequestURL:
type: string
description: >-
The request URI (protocol+host+path+query string) of the
client request
example: 'https://example.com/file.php?param=value'
RequestTime:
type: number
description: Numeric UTC microtimestamp of the request
example: 1608800165613066
default: Cheq's request time
HeaderNames:
type: string
description: >-
List of all raw header names sent by the client in received
order, comma separated
example: 'Host,Connection,Accept,Cache-Control,Cookie,User-Agent'
Host:
type: string
description: Host request Header
example: example.com
UserAgent:
type: string
description: User-Agent request Header
example: >-
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36
Mozilla/5.0 (Windows NT 10.0; Win64; x64)
default: Required if exists in visitor's request
XForwardedFor:
type: string
description: X-Requested-For request Header
example: 208.34.223.183
default: Required if exists in visitor's request
Referer:
type: string
description: Referer request Header
example: example.com
default: Required if exists in visitor's request
Accept:
type: string
description: Accept request Header
example: '*/*'
default: Required if exists in visitor's request
AcceptEncoding:
type: string
description: Accept-Encoding request Header
example: 'gzip, deflate, br'
default: Required if exists in visitor's request
AcceptLanguage:
type: string
description: Accept-Language request Header
example: 'en-US,en;q=0.9'
default: Required if exists in visitor's request
AcceptCharset:
type: string
description: Accept-Charset request Header
example: UTF-8
default: Required if exists in visitor's request
Origin:
type: string
description: Origin request Header
example: 'https://ogs.google.com'
default: Required if exists in visitor's request
XRequestedWith:
type: string
description: X-Requested-With request Header
example: XMLHttpRequestX
default: Required if exists in visitor's request
Connection:
type: string
description: Connection request Header
example: keep-alive
default: Required if exists in visitor's request
Pragma:
type: string
description: Pragma request Header
example: no-cache
default: Required if exists in visitor's request
CacheControl:
type: string
description: Cache-Control request Header
example: max-age=604800
default: Required if exists in visitor's request
ContentType:
type: string
description: Content-Type request Header
example: application/x-www-form-urlencoded;charset=UTF-8
default: Required if exists in visitor's request
TrueClientIP:
type: string
description: True-Client-IP request Header
example: 208.34.223.183
default: Required if exists in visitor's request
XRealIP:
type: string
description: X-Real-IP request Header
example: 208.34.223.183
default: Required if exists in visitor's request
RemoteAddr:
type: string
description: Remote-Addr request Header
example: 208.34.223.183
default: Required if exists in visitor's request
Forwarded:
type: string
description: Forwarded request Header
example: for="_mdn"
default: Required if exists in visitor's request
JA3:
type: string
description: SSL/TLS client fingerprints
example: b32309a26951912be7dba376398abc3b
default: Optional
EventType:
type: string
description: >-
API to support event type as a mandatory field, support
following values: page_load; add_payment; add_to_cart;
add_to_wishlist; registration; purchase; search;
start_trail; subscribe; form_submission; custom;
token_validation;
example: page_load
Channel:
type: string
description: >-
Will be used for Event Name in order to classify request by
user's groups
example: singup-form-area
default: Optional
responses:
'200':
description: Request's fraud-engine response
content:
application/json:
schema:
type: object
description: response object
properties:
version:
type: "integer"
example: 1
isInvalid:
type: "boolean"
example: true
threatTypeCode:
type: "integer"
example: 8
requestId:
type: "string"
example: "62fdc812-be58-492f-9417-66a1f22b4daa"
setCookie:
type: "string"
example: >-
_cheq_rti=L63iI7rybdecVSeqzM/PVycOpvU=ZGwWxfsPAxyh5s8mUcwjeIF1cJ3S6SwqTdVvBsGPguMSthDpj9WxvBihsx9KdhVWvg45gYn2syWngCVg/NLzJ6dFpmbEQ9ZVy+nhVp5s5ROFtdJCbhhKeVDKR3AJzTVl;
Expires=Wed, 04 Jan 2023 10:45:59 GMT; Domain=.example.com
; Path=/
'400':
description: >-
Issue with server request, response body will contain details,
contact us if issue remains
content:
string:
example: Host is missing or invalid
'401':
description: >-
Client request is Unauthorized and should not be allowed, the ApiKey
is not valid
'500':
description: General server error
content:
string:
example: General Error
The issue
after clicking on Execute button the response from the server is not rendering in the response section.
this issue is also reproduce in Swagger Petstore
mamo-t
commented
2 years ago
Q&A (please complete the following information)
OpenAPI definition:
The issue
after clicking on Execute button the response from the server is not rendering in the response section. this issue is also reproduce in Swagger Petstore
To reproduce
Steps to reproduce the behavior:
/store/inventoryExpected behavior
data from the server should be display in the response section
Screenshots