Follow

3.8 API

Har man et eget system (CRM, kundeklub, webshop o.l.), der håndterer medlemmer, så kan en software udvikler lave en API integration til Heyloyalty.

Udviklere kan finde dokumentation her:

https://github.com/Heyloyalty/api/wiki

Hermed kan man ens eget system bl.a. oprette, ændre og slette medlemmer samt læse data fra HL på hvert medlem.

Med bulk funktion er det muligt at oprette/ændre mange medlemmer med ét kald - tilsvarende import funktionerne.

Køn

Ved API skal man anvende 1, 2 eller sætte til tom:

  • 1 = Male / Mand
  • 2 = Female / Kvinde

Land

Når man skal skrive land / country til et medlem, så skal man via API anvende de specielle Heyloyalty koder.

Man kan få en samlet liste ved at lave dette API kald:

loyalty/v1/lists/{list_id}

Dette vil returnere en liste over alle koder og lande:

{
        "3": "Afghanistan",
        "4": "Albania",
        "5": "Algeria",
        "6": "American Samoa",
        "7": "Andorra",
        "8": "Angola",
        "9": "Anguilla",
        "10": "Antarctica",
        "11": "Antigua and Barbuda",
        "12": "Argentina",
        "13": "Armenia",
        "14": "Aruba",
        "15": "Ascension Island",
        "16": "Azerbaijan",
        "17": "Australia",
        "18": "Bahamas",
        "19": "Bahrain",
        "20": "Bangladesh",
        "21": "Barbados",
        "22": "Belgium",
        "23": "Belize",
        "24": "Benin",
        "25": "Bermuda",
        "26": "Bhutan",
        "27": "Bolivia",
        "28": "Bosnia and Herzegovina",
        "29": "Botswana",
        "30": "Bouvet Island",
        "31": "Brazil",
        "32": "Brunei",
        "33": "Bulgaria",
        "34": "Burkina Faso",
        "35": "Burundi",
        "36": "Cambodia",
        "37": "Cameroon",
        "38": "Canada",
        "39": "Cayman Islands",
        "40": "Central African Republic",
        "41": "Ceuta and Melilla",
        "42": "Chile",
        "43": "Clipperton Island",
        "44": "Cocos [Keeling] Islands",
        "45": "Colombia",
        "46": "Comoros",
        "47": "Congo - Brazzaville",
        "48": "Congo - Kinshasa",
        "49": "Cook Islands",
        "50": "Costa Rica",
        "51": "Cuba",
        "52": "Cyprus",
        "53": "Denmark",
        "54": "U.S. Virgin Islands",
        "55": "British Virgin Islands",
        "56": "Palestinian Territories",
        "57": "Dominican Republic",
        "58": "British Indian Ocean Territory",
        "59": "Diego Garcia",
        "60": "Djibouti",
        "61": "Dominica",
        "62": "Ecuador",
        "63": "Egypt",
        "64": "El Salvador",
        "65": "Côte d’Ivoire",
        "66": "Eritrea",
        "67": "Estonia",
        "68": "Ethiopia",
        "69": "Falkland Islands",
        "70": "Fiji",
        "71": "Philippines",
        "72": "Finland",
        "73": "United Arab Emirates",
        "74": "France",
        "75": "French Guiana",
        "76": "French Polynesia",
        "77": "French Southern Territories",
        "78": "Faroe Islands",
        "79": "Gabon",
        "80": "Gambia",
        "81": "Georgia",
        "82": "Ghana",
        "83": "Gibraltar",
        "84": "Grenada",
        "85": "Greece",
        "86": "Greenland",
        "87": "Guadeloupe",
        "88": "Guam",
        "89": "Guatemala",
        "90": "Guernsey",
        "91": "Guinea",
        "92": "Guinea-Bissau",
        "93": "Guyana",
        "94": "Haiti",
        "95": "Heard Island and McDonald Islands",
        "96": "Netherlands",
        "97": "Netherlands Antilles",
        "98": "Honduras",
        "99": "Belarus",
        "100": "India",
        "101": "Indonesia",
        "102": "Iraq",
        "103": "Iran",
        "104": "Ireland",
        "105": "Iceland",
        "106": "Isle of Man",
        "107": "Israel",
        "108": "Italy",
        "109": "Jamaica",
        "110": "Japan",
        "111": "Jersey",
        "112": "Jordan",
        "113": "Christmas Island",
        "114": "Canary Islands",
        "115": "Cape Verde",
        "116": "Kazakhstan",
        "117": "Kenya",
        "118": "China",
        "119": "Kyrgyzstan",
        "120": "Kiribati",
        "121": "Croatia",
        "122": "Kuwait",
        "123": "Laos",
        "124": "Lesotho",
        "125": "Latvia",
        "126": "Lebanon",
        "127": "Liberia",
        "128": "Libya",
        "129": "Liechtenstein",
        "130": "Lithuania",
        "131": "Luxembourg",
        "132": "Madagascar",
        "133": "Macedonia",
        "134": "Malawi",
        "135": "Malaysia",
        "136": "Maldives",
        "137": "Mali",
        "138": "Malta",
        "139": "Morocco",
        "140": "Marshall Islands",
        "141": "Martinique",
        "142": "Mauritania",
        "143": "Mauritius",
        "144": "Mayotte",
        "145": "Mexico",
        "146": "Micronesia",
        "147": "U.S. Minor Outlying Islands",
        "148": "Monaco",
        "149": "Mongolia",
        "150": "Montenegro",
        "151": "Montserrat",
        "152": "Mozambique",
        "153": "Myanmar [Burma]",
        "154": "Namibia",
        "155": "Nauru",
        "156": "Nepal",
        "157": "New Zealand",
        "158": "Nicaragua",
        "159": "Niger",
        "160": "Nigeria",
        "161": "Niue",
        "162": "North Korea",
        "163": "Northern Mariana Islands",
        "164": "Norfolk Island",
        "165": "Norway",
        "166": "New Caledonia",
        "167": "Oman",
        "168": "Pakistan",
        "169": "Palau",
        "170": "Panama",
        "171": "Papua New Guinea",
        "172": "Paraguay",
        "173": "Peru",
        "174": "Pitcairn Islands",
        "175": "Poland",
        "176": "Portugal",
        "177": "Puerto Rico",
        "178": "Qatar",
        "179": "Moldova",
        "180": "Réunion",
        "181": "Romania",
        "182": "Russia",
        "183": "Rwanda",
        "184": "Saint Barthélemy",
        "185": "Saint Kitts and Nevis",
        "186": "Saint Lucia",
        "187": "Saint Martin",
        "188": "Saint Pierre and Miquelon",
        "189": "Solomon Islands",
        "190": "Samoa",
        "191": "San Marino",
        "192": "São Tomé and Príncipe",
        "193": "Hong Kong SAR China",
        "194": "Macau SAR China",
        "195": "Saudi Arabia",
        "196": "Switzerland",
        "197": "Senegal",
        "198": "Serbia",
        "199": "Serbia and Montenegro",
        "200": "Seychelles",
        "201": "Sierra Leone",
        "202": "Singapore",
        "203": "Slovakia",
        "204": "Slovenia",
        "205": "Somalia",
        "206": "South Georgia and the South Sandwich Islands",
        "207": "Spain",
        "208": "Sri Lanka",
        "209": "Saint Helena",
        "210": "Saint Vincent and the Grenadines",
        "211": "United Kingdom",
        "212": "Sudan",
        "213": "Suriname",
        "214": "Svalbard and Jan Mayen",
        "215": "Sweden",
        "216": "Swaziland",
        "217": "South Africa",
        "218": "South Korea",
        "219": "Syria",
        "220": "Tajikistan",
        "221": "Taiwan",
        "222": "Tanzania",
        "223": "Chad",
        "224": "Thailand",
        "225": "Timor-Leste",
        "226": "Czech Republic",
        "227": "Togo",
        "228": "Tokelau",
        "229": "Tonga",
        "230": "Trinidad and Tobago",
        "231": "Tristan da Cunha",
        "232": "Tunisia",
        "233": "Turkmenistan",
        "234": "Turks and Caicos Islands",
        "235": "Tuvalu",
        "236": "Turkey",
        "237": "Germany",
        "238": "Uganda",
        "239": "Ukraine",
        "240": "Hungary",
        "241": "Uruguay",
        "242": "United States",
        "243": "Uzbekistan",
        "244": "Vanuatu",
        "245": "Vatican City",
        "246": "Venezuela",
        "247": "Western Sahara",
        "248": "Vietnam",
        "249": "Wallis and Futuna",
        "250": "Outlying Oceania",
        "251": "Yemen",
        "252": "Zambia",
        "253": "Zimbabwe",
        "254": "Equatorial Guinea",
        "255": "Austria",
        "256": "Åland Islands"
      }

Så til Danmark skal man i stedet for dk i API anvende 53.

Vi arbejder på snarest at få HL til også at acceptere de normale lande forkortelser.

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk