list_destinations

List countries/regions Simsima covers, with min price and product URL.

Parameters

locale	string	optional
region	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "fr"
      ],
      "default": "en"
    },
    "region": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

search_plans

Search plans for a destination (country name or slug), with optional filters.

Parameters

destination	string	required
locale	string	optional
maxPrice	number	optional
minDataGB	number	optional
maxValidityDays	number	optional
unlimited	boolean	optional

Raw schema

{
  "type": "object",
  "properties": {
    "destination": {
      "type": "string"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "fr"
      ],
      "default": "en"
    },
    "maxPrice": {
      "type": "number"
    },
    "minDataGB": {
      "type": "number"
    },
    "maxValidityDays": {
      "type": "number"
    },
    "unlimited": {
      "type": "boolean"
    }
  },
  "required": [
    "destination"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_plan

Get a single plan by its sku.

Parameters

sku	string	required
locale	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "sku": {
      "type": "string"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "fr"
      ],
      "default": "en"
    }
  },
  "required": [
    "sku"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

recommend_plan

Recommend the best plan(s) for a trip given its length and data usage.

Parameters

destination	string	required
tripDays	integer	required
usage	string	required
locale	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "destination": {
      "type": "string"
    },
    "tripDays": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "usage": {
      "type": "string",
      "enum": [
        "light",
        "medium",
        "heavy"
      ]
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "fr"
      ],
      "default": "en"
    }
  },
  "required": [
    "destination",
    "tripDays",
    "usage"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_checkout_link

Return a Simsima product URL with agent attribution, for the user to complete checkout.

Parameters

sku	string	optional
destination	string	optional
agentSource	string	required
locale	string	optional

Raw schema

{
  "type": "object",
  "properties": {
    "sku": {
      "type": "string"
    },
    "destination": {
      "type": "string"
    },
    "agentSource": {
      "type": "string"
    },
    "locale": {
      "type": "string",
      "enum": [
        "en",
        "fr"
      ],
      "default": "en"
    }
  },
  "required": [
    "agentSource"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Simsima Connectivity

list_destinations

search_plans

get_plan

recommend_plan

create_checkout_link

Install

Remote endpoint