API Authentication & Parameters

The common parameters and the structure of the authentication object for using the API

Created by Mustafa Ekim / September, 2022

Testinvite uses JSON data format when communicating through the API. 

All API calls need to have the requester property inside the JSON body.

Testinvite uses the requester property to authenticate the request.

The structure of the requester object is as below:

Type definition of the requester property
Type definition of the requester property
PropertyTypeValue
namestringthe name of your application
versionstringthe version of your application
authobjectthe Organization ID and the Private Key
  • Please read here to learn how to find your Organization ID
    • Please read here to learn how to find your Private Key
      Go Back
      Talk to a representative
      Figure out if TestInvite is a good match for your organization