Authorization: Bearer ADMIN_API_KEY

<dependency>
    <groupId>io.split.api</groupId>
    <artifactId>java-api</artifactId>
    <version>1.1.2</version>
</dependency>

composer require splitsoftware/split-api-client

# Gemfile
gem 'splitapi-rb'

npm install --save @splitsoftware/splitio-api@latest

pip install splitapiclient

Install-Package Splitio.Api

Install-Package Splitio.Api-net-core

import io.split.api.SplitApiClient;

SplitApiClient splitApiClient = SplitApiClient.client(adminToken);

$c = new \SplitIO\ApiClient\SplitApiClient(array(
    'apikey' => 'Admin'
));

client = SplitApi::Client.new(api_key: 'SPLIT_ADMIN_TOKEN')

var SplitAPI = require('@splitsoftware/splitio-api');

// You can instantiate your client with the new keyword, as it is a class
var ApiClient = new SplitAPI.client('your_admin_key', {
  // Your settings
});

// Or you can just call the function.
var ApiClient = SplitAPI.client('your_admin_key', {
  // Your settings
});

// Custom types and interfaces declarations are included on the NPM package under the SplitAPI namespace. 
// Feel free to dive into the declarations whenever intellisense is not enough, they have useful information!
const SplitAPI = require('@splitsoftware/splitio-api');

const apiSettings: SplitAPI.IApiConfig = {
  // Your settings
}

// You can instantiate your client with the new keyword, as it is a class
const ApiClient: SplitAPI.ApiClient = new SplitAPI.client('your_admin_key', apiSettings);

// Or you can just call the function.
const ApiClient: SplitAPI.ApiClient = SplitAPI.client('your_admin_key', apiSettings);

from splitapiclient.main import get_client

# instantiate client        
client = get_client({
    'apikey': 'Admin',
})

 String adminToken = “ANY ADMIN TOKEN”;
 var config = new SplitApiClientConfig();
 config.connectionTimeout = 40000;
 config.debugEnabled = false;
 SplitApiClient client =  new SplitApiClient(adminToken, config);

{
  "id": "string", // Server populated identifier
  "name": "string" // Display name
}

Environment environment = Environment.builder()
  .id("string") // Server populated identifier
  .name("string") // Display name
  .build();

use SplitIO\ApiClient\Resources\Environment;

// Passing an associative array to the constructor:
$env = new Environment(array(
  'id' => 'someId',    
  'name' => 'someName'
));

// Using setters:
$env = new Environment();
$env->setId('someId');
$env->setName('someName');

{
  "id": "string", # Server populated identifier
  "name": "string" # Display name
}

// Environments follow the IEnvironment interface.
interface IEnvironment {
  id: string; // Server populated identifier
  name: string; // Display name
}

// You can either work with an environment instance, using our exposed class:
var myEnv = new SplitAPI.entities.Environment({
  id: 'env_id',
  name: 'env_name'
});
// Or just use a plain object that complies with the interface
var myEnv = {
  id: 'env_id',
  name: 'env_name'
}

// Environments follow the IEnvironment interface.
interface IEnvironment {
  id: string; // Server populated identifier
  name: string; // Display name
}

// You can either work with an environment instance, using our exposed class:
const myEnv = new SplitAPI.entities.Environment({
  id: 'env_id',
  name: 'env_name'
});
// Or just use a plain object that complies with the interface:
const myEnv: SplitAPI.IEnvironment  = {
  id: 'env_id',
  name: 'env_name'
}

from splitapiclient.resources import Environment

# Passing a dict with values:
env = Environment({
    'id': 'someId',
    'name': 'someName',
})

# Using property setters
env = Environment()
env.id = 'someId'
env.name = 'someName'

var environment = new Environment() 
{
   id = "string", // Server populated identifier
   name = "string" // Display name
};

{
  "id": "string", // Server populated identifier
  "name": "string", // Display name
  "displayAttributeId": "string" // (Optional) Attribute used for display name in UI
}

TrafficType trafficType = TrafficType.builder()
	.id(String) // Server populated identifier
  .name(String) // Display name
  .displayAttributeId(String) // (Optional) Attribute used for display name in UI
  .build();

<?php

use SplitIO\ApiClient\Resources\Attribute;

// Passing an associative array 
$attr = new Attribute(array(
  'id' => 'someId',
  'name' => 'someName',
  'displayAttributeId' => 'someDisplayAttributeId' // (Optional) Attribute used for display name in UI
));

// Using setter methods
$attr = new Attribute()
$attr->setId('id' => 'someId');
$attr->setName('someName');
$attr->setDisplayAttributeId('someDisplayAttributeId'); // (Optional) Attribute used for display name in UI
));

{
  "id": "string", # Server populated identifier
  "name": "string", # Display name
  "displayAttributeId": "string" # (Optional) Attribute used for display name in UI
}

// Traffic Types follow the ITrafficType interface.
interface ITrafficType {
  id: string; // Server populated identifier
  name: string; // Display name
  displayAttributeId?: string; // (Optional) Attribute used for display name in UI
}

// You can either work with a Traffic Type instance, using our exposed class:
var myTT = new SplitAPI.entities.TrafficType({
  id: 'tt_id',
  name: 'tt_name'
});
// Or just use a plain object that complies with the interface:
var myTT = {
  id: 'tt_id',
  name: 'tt_name'
};

// Traffic Types follow the ITrafficType interface.
interface ITrafficType {
  id: string; // Server populated identifier
  name: string; // Display name
  displayAttributeId?: string; // (Optional) Attribute used for display name in UI
}

// You can either work with a Traffic Type instance, using our exposed class:
const myTT = new SplitAPI.entities.TrafficType({
  id: 'tt_id',
  name: 'tt_name'
});
// Or just use a plain object that complies with the interface:
const myTT: SplitAPI.ITrafficType = {
  id: 'tt_id',
  name: 'tt_name'
};

from splitapiclient.resources import TrafficType

# Using dict with properties
tt = TrafficType({
    'id': 'someId',
    'name': 'someName',
    'displayAttributeId': 'someDisplayAttributeId' # (Optional) Attribute used for display name in UI
})

# Using property setters
tt = TrafficType()
tt.id = 'someId'
tt.name = 'someName'
tt.display_attribute_id = 'someDisplayAttributeId' # (Optional) Attribute used for display name in UI

var trafficType = new TrafficType() 
{
  id = "string", // Server populated identifier
  name = "string", // Display name
  displayAttributeId = "string" // (Optional) Attribute used for display name in UI
};

{
  "id": "string", // Attribute identifier, same as used in identity value map
  "trafficTypeId": "string", // Traffic type this attribute is associated with
  "displayName": "string", // (Optional) How the attribute will be displayed in the UI, defaults to the id
  "description": "string", // (Optional) A description of the attribute
  "dataType": "string", // (Optional) The data type of the attribute used for display formatting, defaults to displaying the raw string. Must be one of: null, "string", "datetime", "number", "set"
  "isSearchable": boolean // (Optional) If the attribute should appear in segment and whitelist search
}

Attribute attribute = Attribute.builder()
  .id(String) // Attribute identifier, same as used in identity value map
  .trafficTypeId(String) // Traffic type identifier
  .trafficType(TrafficType) // OR: traffic type object
  .dataType(String) // (Optional) The data type of the attribute used for display formatting, defaults to displaying the raw string
  .displayName(String) // (Optional) How the attribute will be displayed in the UI, defaults to the id
  .description(String) // (Optional) A description of the attribute
  .isSearchable(Boolean) // (Optional) If the attribute should appear in segment and whitelist search
  .build();

<?php

use SplitIO\ApiClient\Resources\Attribute;

// Passing an associative array of properties
$attr = new Attribute(array(
  'id' => 'someId',
  'trafficTypeId' => 'someTrafficTypeId',
  'displayName' => 'someDisaplayName',
  'description' => 'someDescription',
  'dataType' => 'STRING',
  'isSearchable' => false
));

// Using setter methods
$attr = new Attribute();
$attr->setId('someId');
$attr->setTrafficTypeId('someTrafficTypeId');
$attr->setDisplayName('someDisaplayName');
$attr->setDescription('someDescription');
$attr->setDataType('STRING');
$attr->setIsSearchable(false);

{
  "id": "string", # Attribute identifier, same as used in identity value map
  "trafficTypeId": "string", # Traffic type this attribute is associated with
  "displayName": "string", # (Optional) How the attribute will be displayed in the UI, defaults to the id
  "description": "string", # (Optional) A description of the attribute
  "dataType": "string", # (Optional) The data type of the attribute used for display formatting, defaults to displaying the raw string
  "isSearchable": boolean # (Optional) If the attribute should appear in segment and whitelist search
}

// Attributes follow the IAttribute interface
interface IAttribute {
  id: string; // Attribute identifier, same as used in identity value map
  trafficTypeId: string; // Traffic type this attribute is associated with
  displayName?: string; // (Optional) How the attribute will be displayed in the UI, defaults to the id
  dataType?: string; // (Optional) The data type of the attribute used for display formatting, defaults to displaying the raw string
  description?: string; // (Optional) A description of the attribute
  isSearchable?: boolean; // (Optional) If the attribute should appear in segment and whitelist search
}

// You can either work with an attribute instance, using our exposed class:
var myAttribute = new SplitAPI.entities.Attribute({
  trafficTypeId: 'a_traffic_type_id',
  id: 'attr_id'
});
// Or just use a plain object that complies with the interface:
var myAttribute = {
  trafficTypeId: 'a_traffic_type_id',
  id: 'attr_id'
};

// Attributes follow the IAttribute interface
interface IAttribute {
  id: string; // Attribute identifier, same as used in identity value map
  trafficTypeId: string; // Traffic type this attribute is associated with
  displayName?: string; // (Optional) How the attribute will be displayed in the UI, defaults to the id
  dataType?: string; // (Optional) The data type of the attribute used for display formatting, defaults to displaying the raw string
  description?: string; // (Optional) A description of the attribute
  isSearchable?: boolean; // (Optional) If the attribute should appear in segment and whitelist search
}

// You can either work with an attribute instance, using our exposed class:
const myAttribute = new SplitAPI.entities.Attribute({
  trafficTypeId: 'a_traffic_type_id',
  id: 'attr_id'
});
// Or just use a plain object that complies with the interface:
const myAttribute: SplitAPI.IAttribute = {
  trafficTypeId: 'a_traffic_type_id',
  id: 'attr_id'
};

from splitapiclient.resources import Attribute

# Passing a dict with properrties
attr = Attribute({
    'id': 'someId',
    'trafficTypeId': 'someTrafficTypeId',
    'displayName': 'someDisplayName',
    'description': 'someDescription',
    'dataType': 'STRING',
    'isSearchable': False
})

# Using property setters
attr = Attribute()
attr.id = 'someId'
attr.traffic_type_id = 'someTrafficTypeId'
attr.display_name = 'someDisplayName'
attr.description = 'someDescription'
attr.dataType = 'STRING'
attr.isSearchable = False

var attribute = new Attribute()
{
  id = "string", // Attribute identifier, same as used in identity value map
  trafficTypeId = "string", // Traffic type this attribute is associated with
  displayName = "string", // (Optional) How the attribute will be displayed in the UI, defaults to the id
  description = "string", // (Optional) A description of the attribute
  dataType = "string" // (Optional) The data type of the attribute used for display formatting, defaults to displaying the raw string
  isSearchable = boolean; // (Optional) If the attribute should appear in segment and whitelist search
}

{
  key: "string", // Key used for getTreatment() calls
  trafficTypeId: "string", // Traffic Type Identifier
  environmentId: "string", // Environment Identifier
  values: { // Attribute Values (key: Attribute Id, value: value)
    key: "string",
    ...
  }
}

Identity identity = Identity.builder()
  .key(String)                // Key used for getTreatment() calls
  .trafficTypeId(String)      // Traffic type identifier
  .trafficType(TrafficType)   // OR: Traffic type object
  .environmentId(String)      // Environment identifier
  .environment(Environment)   // OR: Environment object
  .timestamp(long)            // (Optional) Time of last update
  .values(Map<String,String>) // Attribute values (key: Attribute ID, value: value)
  .build();

<?php

use SplitIO\ApiClient\Resources\Identity;

$id1 = new Identity(array(
  'key' => 'someKey',
  'trafficTypeId' => 'someTrafficTypeId',
  'environmentId' => 'someEnvironmentId',
  'values' => array(
    'attribute1' => 'value1',
    'attribute2' => 'value2'
  )
))
  
$id1 = new Identity();
$id1->setKey('someKey');
$id1->setTrafficTypeId('someTrafficTypeId');
$id1->setEnvironmentId('someEnvironmentId');
$id1->setValues(array(
  'attribute1' => 'value1',
  'attribute2' => 'value2'
));


    

{
  key: "string", # Key used for getTreatment() calls
  trafficTypeId: "string", # Traffic type identifier
  environmentId: "string", # Environment identifier
  values: { # Attribute Values (key: Attribute ID, value: value)
    key: "string",
    ...
  }
}

// Identities follow the IIdentity interface
interface IIdentity {
  key: string; // Key used for getTreatment() calls
  environmentId: string; // Environment identifier
  trafficTypeId: string; // Traffic type identifier
  organizationId?: string; // (Optional) Organization identifier
  timestamp?: number; // (Optional) Time of last update
  values?: { // Attribute Values (key: Attribute ID, value: value)
    [key: string]: string
  };
}

// You can either work with an identity instance, using our exposed class:
var myIdentity = new SplitAPI.entities.Identity({
  key: 'a_key', 
  environmentId: 'env_id', 
  trafficTypeId: 'tt_id', 
  values: { 
    'email': 'mail@gmail.com'
  }
});
// Or just use a plain object that complies with the interface:
var myIdentity = {
  key: 'a_key', 
  environmentId: 'env_id', 
  trafficTypeId: 'tt_id', 
  values: { 
    'email': 'mail@gmail.com'
  }
};

// Identities follow the IIdentity interface
interface IIdentity {
  key: string; // Key used for getTreatment() calls
  environmentId: string; // Environment Identifier
  trafficTypeId: string; // Traffic type Identifier
  organizationId?: string; // (Optional) Organization identifier
  timestamp?: number; // (Optional) Time of last update
  values?: { // Attribute values (key: Attribute ID, value: value)
    [key: string]: string
  };
}

// You can either work with an identity instance, using our exposed class:
const myIdentity = new SplitAPI.entities.Identity({
  key: 'a_key', 
  environmentId: 'env_id', 
  trafficTypeId: 'tt_id', 
  values: { 
    'email': 'mail@gmail.com'
  }
});
// Or just use a plain object that complies with the interface:
const myIdentity: SplitAPI.IIdentity = {
  key: 'a_key', 
  environmentId: 'env_id', 
  trafficTypeId: 'tt_id', 
  values: { 
    'email': 'mail@gmail.com'
  }
};

from splitapiclient.resources import Identity

# Passing a dict of properties to the constructor
id1 = Identity({
    'key': 'someKey',
    'trafficTypeId': 'someTrafficTypeId',
    'environmentId': 'someEnvironmentId',
    'values': {
        'attribute1': 'value1',
        'attribute2': 'value2',
    }
})

# Using property setters
id1 = Identity()
id1.key = 'someKey'
id1.traffic_type_id = 'someTrafficTypeId'
id1.environment_id = 'someEnvironmentId'
id1.values = {
  'attribute1': 'value1',
  'attribute2': 'value2',
}

var values = new Dictionary<string, string>();
values.Add("attribute id", "value");
var identity = new Identity() 
{ 
  key = "key", // Key used for getTreatment() calls
  environmentId = "environmentId", // Environment identifier
  trafficTypeId = "trafficTypeId", // Traffic type identifier
  values = values // Attribute values (key: Attribute ID, value: value)
};

{
    "name": String,
    "environment": { "id": String, "name": String }, 
    "trafficType": { "id": String, "name": String }, 
    "creationTime": Number 
}

{
    "objects": [ SEGMENT_IN_ENVIRONMENT ], // Array of Segments returned
    "offset": Number, // Offset received
    "limit": Number, // Limit received
    "totalCount": Number // Total number of Segments for the environment
}

["id_1", "id_2", "id_3", .... ]

["id_1", "id_2", "id_3", .... ]

{
    "name": String,
    "description": String, 
    "trafficType": { "id": String, "name": String }, 
    "creationTime": Number,
    "tags" : [{ "name": String }]
}

{
	“name”: String,
	“environment”: { "id": String, "name": String },
 	“trafficType“: { "id": String, "name": String },
	“killed”: Boolean,
	“treatments”: [ Treatment ],
	“defaultTreatment”: String,
	“trafficAllocation”: Number,
	“rules”: [ Rule ], 
	“defaultRule”: [ Bucket ],
	“creationTime”: Number,
	“lastUpdateTime”: Number,
}

{
  “name”: String,
  “description”: String,
  “keys”: [ String ],
  “segments”: [ String ]
}

{
  “condition”: Condition,
  “buckets”: [ Bucket ]
}

{
  “combiner”: "AND",
  “matchers”: [ Matcher ]
}

{
  “treatment”: String,
  “size”: Number
}

{
  “negate”: Boolean,
  “type”: MatcherType,
  “attribute”: String,
  "string": String,
  "bool" : Boolean,
  "strings" : [ String ],
  "number" : Number,
  "date" : Number,
  "between": { "from" : Number, "to" : Number },
  "depends": { "splitName": String, "treatment": String }
}

{
  IN_SEGMENT,
  
  EQUAL_SET,
  ANY_OF_SET,
  ALL_OF_SET,
  PART_OF_SET,

  ON_DATE,
  ON_OR_AFTER_DATE,
  ON_OR_BEFORE_DATE,
  BETWEEN_DATE,

  BOOLEAN,
  
  EQUAL_NUMBER,
  LESS_THAN_OR_EQUAL_NUMBER,
  GREATER_THAN_OR_EQUAL_NUMBER,
  BETWEEN_NUMBER,

  IN_LIST_STRING,
  STARTS_WITH_STRING,
  ENDS_WITH_STRING,
  CONTAINS_STRING,
  MATCHES_STRING,
  
  IN_SPLIT,
}

{
  "rules" : [{ "..." }],
  "defaultRule": [ 
    { "treatment": "on", size: 90 },
    { "treatment": "off", size: 10 } 
  ]
}

{
 "name": String, // Mandatory
 "description": String // Optional
}

var splitName = "TestSplit";
var trafficType = "user";
var description = "test description";
var newSplit = client.Splits().Create(splitName, trafficType, description);

{
    "name": String,
    "description": String, 
    "trafficType": URN, // Containing id and name of the Traffic Type
    "creationTime": Number // Milliseconds since epoch
}

var split = client.Splits().Get("TestSplit");

{
    "objects": [ SPLIT ], // Array of Splits returned
    "offset": Number, // Offset received
    "limit": Number, // Limit received
    "totalCount": Number // Total number of Splits
}

var splits = client.Splits().List();

{
  "treatments": [ Treatment ], // Mandatory
  "defaultTreatment": String, // Mandatory
  "rules": [ Rule ], // Optional
  "defaultRule": [ Bucket ] // Mandatory
}

{
    "name": String,
    "environment": URN, // Containing id and name of the environment
    "killed": Boolean,
    "treatments": [ Treatment ],
    "defaultTreatment": String,
    "trafficAllocation": Number, // Between 0 and 100
    "rules": [ Rule ],
    "creationTime": Number, // Milliseconds since epoch
    "lastUpdateTime": Number // Milliseconds since epoch
}

curl -v -X PATCH \
  -d '[{"op": "replace", "path": "/killed", "value": true}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "replace", "path": "/trafficAllocation", "value":50}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "replace", "path": "/defaultTreatment", "value": "on"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "add", "path": "/treatments/0/keys/-", "value": "4"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "remove", "path": "/treatments/0/keys/2"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "replace", "path": "/treatments/0/keys/0", "value": "7"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "add", "path": "/treatments/1/segments/-", "value": "beta"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "remove", "path": "/treatments/0/segments/1"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

{
 "...",
 "treatments" :[{ "name":"on" }, {"name":"off" } ],
 "rules" :[
  {
   "...",
   "buckets": [
    { "treatment":"on","size":80 },
    { "treatment":"off","size":20 }
   ]
  }
 ],
 "defaultRule": [
   { "treatment":"on", "size": 50 },
   { "treatment":"off", "size": 50}
 ],
 "..."
}

curl -v -X PATCH \
  -d '[{ "op": "replace", "path": "/rules/0/buckets/0/treatment", "value": "first_version" }, { "op": "replace", "path": "/treatments/0/name", "value": "first_version" }, { "op": "replace", "path": "/defaultRule/0/treatment", "value": "first_version" }]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

{
 "...",
 "treatments" :[{ "name":"on" }, {"name":"off" } ],
 "rules" :[{"..."}],
 "defaultRule": [
   { "treatment":"on", "size": 50 },
   { "treatment":"off", "size": 50}
 ],
 "..."
}

curl -v -X PATCH \
  -d '[{"op": "add", "path": "/rules/0", "value": {"buckets":[{"treatment":"on","size":50},{"treatment":"off","size":50}],"condition":{"matchers":[{"type":"IN_SEGMENT","string":"employees"}]}}}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production

curl -v -X PATCH \
  -d '[{"op": "remove", "path": "/rules/1"}]' \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer ADMIN_API_KEY' \
  https://api.split.io/internal/api/v1/splits/paywall_beta/environments/Production