API Reference

Deep Linking for eSIM Data Package Optimization

Overview

Deep links serve as a powerful tool for seamlessly guiding users through tailored experiences by activating hyperlinks that contain predefined URL parameters. In the realm of eSIM data packages, integrating deep links becomes instrumental in improving the customer journey. This feature allows us to optimize our offerings based on specific user needs, resulting in a more efficient e-commerce flow and an enhanced conversion rate.

📘

Understanding Deep Links

Deep links are URLs enriched with additional parameters, offering valuable insights into user preferences. For a comprehensive grasp of deep links, refer to the concept on Wikipedia - Query string.

Leveraging Deep Links for eSIM Data Packages

1. Accurate Offer Customization

By incorporating deep links in eSIM data packages, we gain the capability to precisely customize offers to individual customer requirements. This involves embedding relevant parameters within the deep links to convey specific customer needs effectively.

2. Streamlining E-commerce Flow

Deep links empower us to design a more intuitive and efficient e-commerce flow. By eliminating unnecessary steps and pre-populating critical information through URL parameters, we enhance the overall user experience and reduce friction in the customer journey.

3. Improving Conversion Rate

The integration of deep links with eSIM data packages significantly contributes to an improved conversion rate. A streamlined and personalized experience, facilitated by deep links, encourages users to complete transactions, maximizing the effectiveness of our e-commerce platform.

📘

Simtex available parameters

Parameter nameExample (Key=Value)Notes
Destinations & Daysdest=IT,3
(One destination)

dest=IT,3,FR,4
(Two destinations)
ISO_3166-1_alpha-2 [Full list of Available Destinations]
**It must be a destination and days, only a destination or only a day will not work
Customers namesnames=John,MaryText
Languagelang=enISO_639-1 [Full list of Available languages]
Buyer NamebuyerName=JohnText
Currencycurrency=EURISO_4217 [Full list of Available currencies]
**Capital letters
Email addressemail=[email protected]Text
Tax ID numbertaxid=9876543Text
Coupon codecoupon=holiday10Text
Partner Reference ref=PNR12345Text (Sent in callback to the web-hook address)
Landing pagelp=falseThe default setting is landing page=true

💡

Example with parameters:

https://{{yourDomain)/#/shopping?currency=EUR&dest=IT,3,FR,4&names=John,Marry&lang=en&buyerName=John&[email protected]&taxid=9876543&coupon=holiday10&ref=PNR12345

Full list of Available Parameters

  • Currency list

    CurrencyCurrency ISO code (ISO_4217)
    EuroEUR
    United States dollarUSD
    Israeli shekelILS
    Pound sterlingGBP
  • languages list

    LanguageLanguage ISO code (ISO_639-1)
    Englishen
    Hebrewhe
    Polskipl
    Germande
    Srpskisr
  • Countries list

NameCountry ISO code (ISO_3166-1_alpha-2)
AndorraAD
United Arab EmiratesAE
AfghanistanAF
Antigua and BarbudaAG
AnguillaAI
AlbaniaAL
ArmeniaAM
ArgentinaAR
AustriaAT
AustraliaAU
ArubaAW
AzerbaijanAZ
Bosnia and HerzegovinaBA
BarbadosBB
BangladeshBD
BelgiumBE
Burkina FasoBF
BulgariaBG
BahrainBH
BeninBJ
BermudaBM
Brunei DarussalamBN
Bolivia (Plurinational State of)BO
BrazilBR
BhutanBT
BotswanaBW
BelarusBY
CanadaCA
Congo (Democratic Republic of the)CD
Central African RepublicCF
CongoCG
SwitzerlandCH
Cote d'IvoireCI
ChileCL
CameroonCM
ChinaCN
ColombiaCO
Costa RicaCR
Cabo VerdeCV
CyprusCY
CzechiaCZ
GermanyDE
DenmarkDK
DominicaDM
Dominican RepublicDO
AlgeriaDZ
EcuadorEC
EstoniaEE
EgyptEG
SpainES
EthiopiaET
FinlandFI
FijiFJ
Faroe IslandsFO
FranceFR
GabonGA
United Kingdom of Great Britain and Northern IrelandGB
GrenadaGD
GeorgiaGE
GuernseyGG
GhanaGH
GibraltarGI
GreenlandGL
GambiaGM
GuineaGN
GreeceGR
GuatemalaGT
GuamGU
Guinea-BissauGW
GuyanaGY
Hong KongHK
HondurasHN
CroatiaHR
HungaryHU
IndonesiaID
IrelandIE
IsraelIL
Isle of ManIM
IndiaIN
IraqIQ
Iran (Islamic Republic of)IR
IcelandIS
ItalyIT
JerseyJE
JamaicaJM
JordanJO
JapanJP
KenyaKE
KyrgyzstanKG
CambodiaKH
Saint Kitts and NevisKN
Korea (Republic of)KR
KuwaitKW
Cayman IslandsKY
KazakhstanKZ
Lao People's Democratic RepublicLA
LebanonLB
Saint LuciaLC
LiechtensteinLI
Sri LankaLK
LiberiaLR
LesothoLS
LithuaniaLT
LuxembourgLU
LatviaLV
MoroccoMA
MonacoMC
Moldova (Republic of)MD
MontenegroME
MadagascarMG
North MacedoniaMK
MaliML
MyanmarMM
MongoliaMN
MacaoMO
Northern Mariana IslandsMP
MauritaniaMR
MontserratMS
MaltaMT
MauritiusMU
MaldivesMV
MalawiMW
MexicoMX
MalaysiaMY
MozambiqueMZ
NigerNE
Norfolk IslandNF
NigeriaNG
NicaraguaNI
NetherlandsNL
NorwayNO
NepalNP
New ZealandNZ
OmanOM
PanamaPA
PeruPE
Papua New GuineaPG
PhilippinesPH
PakistanPK
PolandPL
Puerto RicoPR
PalestinePS
PortugalPT
ParaguayPY
QatarQA
RomaniaRO
SerbiaRS
Russian FederationRU
RwandaRW
Saudi ArabiaSA
Solomon IslandsSB
SeychellesSC
SudanSD
SwedenSE
SingaporeSG
SloveniaSI
SlovakiaSK
Sierra LeoneSL
SenegalSN
SurinameSR
El SalvadorSV
EswatiniSZ
Turks and Caicos IslandsTC
ChadTD
ThailandTH
TajikistanTJ
TunisiaTN
TongaTO
TurkeyTR
Trinidad and TobagoTT
Taiwan (Province of China)TW
TanzaniaTZ
UkraineUA
UgandaUG
United States of AmericaUS
UruguayUY
UzbekistanUZ
Saint Vincent and the GrenadinesVC
Venezuela (Bolivarian Republic of)VE
Virgin Islands (British)VG
Viet NamVN
VanuatuVU
South AfricaZA
ZambiaZM