api.vtxhub.com Open in urlscan Pro
192.227.107.11  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Getting Started
 * Authentication
 * post Access Tokens
   /oauth/token
 * post Grant Basic Create
   /oauth/grant/basic
 * post Grant OTP Create
   /oauth/grant/otp
 * Polling
 * post Check for Work
   /poll
 * Accounts API
 * get AccountPersonalizationsGet
   /v1/user/:handle/personalizations
 * post AccountPersonalizationsInsert
   /v1/user/:handle/personalizations
 * Interceptions
 * remove Delete All
   /interceptions
 * remove Delete One
   /interception/:interception
 * post Insert
   /interception/:interception
 * get Search
   /interceptions
 * post Update
   /interception/:interception
 * Queues
 * Copyright


VORTEX CLIENT API

v. 1.0.0  
 * Compare all with predecessor
 * 
 * show up to version:
 * 1.0.0
 * 0.0.0



Debug remote API's faster by creating rules which siphon realtime transactions
from a remote api server and deliver them to your local computer so you may
troubleshoot them using source code, your favorite IDE, and native debugger
breakpoints.


GETTING STARTED

 1. Create your account at Vortex Hub
 2. Add your domain and create a rule
 3. Run the sample client at Github

After you are familiar with how the sample client works, use this documentation
to build your own client that better suit the needs of your organization.

Use these endpoints to sign into Vortex and interact with the API.

OAuth 2.0 supports several different grants. Grants are ways of retrieving an
Access Token. Deciding which one is suited for your case depends mostly on your
Client's type, but other parameters weigh in as well, like the level of trust
for the Client, or the experience you want your users to have.

If the Client is a regular web app executing on a server, then the Authorization
Code Flow (Authorization Code grant) is the flow you should use. Using this the
Client can retrieve an Access Token and, optionally, a Refresh Token. It's
considered the safest choice since the Access Token is passed directly to the
web server hosting the Client, without going through the user's web browser and
risk exposure.

You can retrieve your own access token by using the /oauth/token endpoint and
supplying one of the supported grant types.




[ AUTHENTICATION ]


POST ACCESS TOKENS

1.0.0 
 * compare changes to:
 * 1.0.0





Basic authentication is based on OAuth 2.0 standards and allows a user to
request access to the API by supplying a basic credential.

The access_token and the grant_type in the successful authorization response
must be added to all subsequent HTTP calls to the API.

For example, if you receive back a grant_type bearer having an access token
attaching 123-456 your subsequent HTTP calls must have an authorization header
that looks like the following:

Authorization: bearer 1234-5678

After an idle time of 1 hour, your access_token will expire. You will then
receive HTTP 401 errors when attempting to access the API. To remedy this
situation, you can supply a refresh_grant to this same authentication endpoint
and get back a fresh access_token with updated context data. The resulting
access_token will be no different than the token supplied when issuing a
password_grant credential.






https://api.vtxhub.com/v1/oauth/token

 * Request-Example: basic credential
 * Request-Example: refresh

{
   grant_type: 'password_grant',   // grant type
   username: 'XXXXXXX',            // email address used at vtxhub.com
   password: 'XXXXXXX'             // top secret password
}

{
   grant_type: 'refresh_grant',    // grant type
   client_id: 'XXXXXXX',           // expired access_token
   client_secret:  'XXXXXXX'       // valid refresh_token
}

 * Response-Example:

{
 grant_type: 'bearer',                 // used in your authorization header when making an API request
 access_token: '51e21a3d-ea46-4390',   // used in your authorization header when making an API request
 refresh_token: 'refresh-120bfbd2',    // token used to refresh your access_token should it expire
 expires_in: 3600,                     // seconds before your access_token expires due to inactivity
 client_id: 'user@example.com',        // username that is assigned this access_token
 scope: 'user',                        // roles granted to this access_token
 context: {                            // user context data
   handle: 'example12345',             // context unique identity
   roles: [ 'granted roles' ],         // roles granted to this context
   email: 'vtx-admin@bitvisory.com',   // context email address
   created_at: '2020-01-01',           // date created
   updated_at: '2020-01-10',           // date last modified
   enabled: true                       // status
 }
}


[ AUTHENTICATION ]


POST GRANT BASIC CREATE

1.0.0 
 * compare changes to:
 * 1.0.0





Create a basic client credential



https://api.vtxhub.com/v1/oauth/grant/basic


[ AUTHENTICATION ]


POST GRANT OTP CREATE

1.0.0 
 * compare changes to:
 * 1.0.0





Send a one time password for use with a grant



https://api.vtxhub.com/v1/oauth/grant/otp

Vortex uses polling to facilitate inter-process communication. All clients must
poll the server at least once every 5 seconds or they will be considered idle
and eventually disconnected.




[ POLLING ]


POST CHECK FOR WORK

1.0.0 
 * compare changes to:
 * 1.0.0





The poll endpoint provides you with a list of interceptions from the journal
that match your filter.






https://api.vtxhub.com/v1/poll

 * Request-Example: PollFilterModel

{
   interception: {
       status: string      // status filter in the range ['new', 'reply', 'accept', 'purge']
   }
}

 * Response-Example: new

{
   interceptions: [             // PollingResponseModel
        interception: {         // InterceptionModelFragment
            interception: '',   // interception uuid
            input: {},          // input data from the HTTP request
            output: {},         // output data from the HTTP response
            status: '',         // current journal queue status
        },
        breakpoint: {            // BreakpointModelFragment
            name: '',            // breakpoint name
            webapp: '',          // WebApp identity to attach breakpoint
            http_verb: '',       // HTTP verb to match
            url_type: '',        // Url match type
            url_text: '',        // Url match text
            query_type: '',      // Query string match type
            query_text: '',      // Query string match text
            header_name: '',     // Header match variable name
            header_value: '',    // Header match text
            enabled: ''          // Breakpoint enabled flag
        }
   }, ... multiple ]
}

These endpoints deal with authentication, personalization and membership




[ ACCOUNTS API ]


GET ACCOUNTPERSONALIZATIONSGET

Permission: user

0.0.0 
 * compare changes to:
 * 0.0.0





Get account personalization data



https://api.vtxhub.com/v1/v1/user/:handle/personalizations

 * Angular

var example = 'here';
$http(example).then(function(success){...}, function(failure){...});


PARAMETER

Field Type Description handle String

Personalization identity


SUCCESS 200

Field Type Description data object

JSON data containing response

 * Success-Response:

HTTP/1.1 200 OK
{ example: 'here'}


[ ACCOUNTS API ]


POST ACCOUNTPERSONALIZATIONSINSERT

Permission: user

0.0.0 
 * compare changes to:
 * 0.0.0





Get personalization data by identity



https://api.vtxhub.com/v1/v1/user/:handle/personalizations

 * Angular

var example = 'here';
$http(example).then(function(success){...}, function(failure){...});


PARAMETER

Field Type Description handle String

Personalization identity


SUCCESS 200

Field Type Description data object

JSON data containing response

 * Success-Response:

HTTP/1.1 200 OK
{ example: 'here'}

Use these endpoints to manage interceptions in the journal




[ INTERCEPTIONS ]


REMOVE DELETE ALL

1.0.0 
 * compare changes to:
 * 1.0.0





Delete all interceptions



https://api.vtxhub.com/v1/interceptions

 * Output

Returns nothing
{
}


[ INTERCEPTIONS ]


REMOVE DELETE ONE

1.0.0 
 * compare changes to:
 * 1.0.0





Delete one interceptions



https://api.vtxhub.com/v1/interception/:interception

 * Output

Returns nothing
{
}


[ INTERCEPTIONS ]


POST INSERT

1.0.0 
 * compare changes to:
 * 1.0.0





Use this endpoint to create an interception in the journal.



https://api.vtxhub.com/v1/interception/:interception

 * Output

Returns the modified InterceptionModel
{
    interceptions: [ {
         interception: '1111-11-11111',
         input: {},
         output: {},
         status: '',
         enabled: true
    } ]
}


[ INTERCEPTIONS ]


GET SEARCH

1.0.0 
 * compare changes to:
 * 1.0.0





List all interceptions



https://api.vtxhub.com/v1/interceptions

 * Output

Returns an array of InterceptionModel
{
    interceptions: [ {
         interception: '1111-11-11111',
         input: {},
         output: {},
         status: '',
         enabled: true
    } ]
}


[ INTERCEPTIONS ]


POST UPDATE

1.0.0 
 * compare changes to:
 * 1.0.0





Use this endpoint to modify interceptions stored in the journal.



https://api.vtxhub.com/v1/interception/:interception

 * Output

Returns the modified InterceptionModel
{
    interceptions: [ {
         interception: '1111-11-11111',
         input: {},
         output: {},
         status: '',
         enabled: true
    } ]
}

Use these endpoints to manage work items found in queues




[ QUEUES

1.0.0 
 * compare changes to:
 * 1.0.0





Delete a queue item



https://api.vtxhub.com/v1/queue/:model/:owner/:id

 * Output


Returns a QueueModel
        model: string,           // string to describe the model used
        owner: string,           // string to describe the owner identitiy
        id: string,              // string identity of the queue entry
        ack: bool,               // boolean to indicate entity is acknowledged
        end: bool,               // boolean to indicate entity is complete
        ack_date: Date,          // date time when entry was last acknowledged
        end_date: Date,          // date time when entry was last ended
        create_date: Date,       // date time when entry was created
        input: JSON,             // variable JSON object, strict schema based on model
        output: JSON,            // variable JSON object, strict schema based on model


PARAMETER

Field Type Description model String

Model

owner String

Owner

id String

Identity


[ QUEUES

1.0.0 
 * compare changes to:
 * 1.0.0





Insert a queue entry



https://api.vtxhub.com/v1/queue/:model/:owner/

 * Input

Accepts an QueueModelFragment with any of
        ack: bool,               // boolean to indicate entity is acknowledged
        end: bool,               // boolean to indicate entity is complete
        input: JSON,             // variable JSON object, strict schema based on model


PARAMETER

Field Type Description model String

Model

owner String

Owner


[ QUEUES

1.0.0 
 * compare changes to:
 * 1.0.0





Get a queue entry list



https://api.vtxhub.com/v1/queue/:model/:owner

 * Output

Returns an Array of QueueModel
        model: string,           // string to describe the model used
        owner: string,           // string to describe the owner identitiy
        id: string,              // string identity of the queue entry
        ack: bool,               // boolean to indicate entity is acknowledged
        end: bool,               // boolean to indicate entity is complete
        ack_date: Date,          // date time when entry was last acknowledged
        end_date: Date,          // date time when entry was last ended
        create_date: Date,       // date time when entry was created
        input: JSON,             // variable JSON object, strict schema based on model
        output: JSON,            // variable JSON object, strict schema based on model


PARAMETER

Field Type Description model String

Model

owner String

Owner


[ QUEUES

1.0.0 
 * compare changes to:
 * 1.0.0





Get a queue entry



https://api.vtxhub.com/v1/queue/:model/:owner/:id

 * Output

Returns a QueueModel
        model: string,           // string to describe the model used
        owner: string,           // string to describe the owner identitiy
        id: string,              // string identity of the queue entry
        ack: bool,               // boolean to indicate entity is acknowledged
        end: bool,               // boolean to indicate entity is complete
        ack_date: Date,          // date time when entry was last acknowledged
        end_date: Date,          // date time when entry was last ended
        create_date: Date,       // date time when entry was created
        input: JSON,             // variable JSON object, strict schema based on model
        output: JSON,            // variable JSON object, strict schema based on model


PARAMETER

Field Type Description model String

Model

owner String

Owner

All documentation is Copyright (c) 2020 Bitvisory Inc.

Generated with apidoc 0.17.6 - 2021-07-09T18:55:30.282Z