Introduction

Welcome to Adelya's API home page. Below you can find a quick introduction to our CRM Platform API. This is an XML/Json read/write over HTTP API, that enables you to access all the business objects of LoyaltyOperator and client websites.

Credentials

To handle the connection credential you need to add a basicAuth header to your https call. You will need an API key and a user password. To get these, you'll need to enroll in our technical partner program.

In short you'll have to add an HTTP header : "Authorization" which value is "Basic <here the base64 encoded string of apikey;user_login:user_password>. See here for more info and a alternative tokenized version.

Exemple 1

Read customer info based on its loyalty card number.

Get customer (json)
Get customer (xml)

Http GET on apiv1/webapi.do

param : json_data


{
 "FidelityMember":{
  "cardnumber":"10001234", "actif":1
 }
}

The return is (show/hide)


{
 "FidelityMember":
  {
        "id":"3325067","uniqueId":"1cba11fe-b941-47ee-8ab6-598ee39de2f4",
        "cardnumber":"10001234","type":"C","src":"C",
        "gender":null,"name":"JEAN","firstname":"Dujardin","login":"581357",
        "mobile":"0601020304",
        "nbPoint":"0","cumulPoint":"0","nbCredit":"0.0","cumulCredit":"0.0","cumulCA":"0.0","montantCA":"0.0",
        "tel":null,"zip":"31400","smsoptin":false,"emailoptin":false,"mailoptin":true,"partneroptin":false,
        "sponsored":false,"actif":"1","npei":true,"npmi":false,"netPrice":"0.0",
        "dateCreate":"2012-07-10 17:25:04","dateRenew":"2013-07-10 17:25:04","dateUpdate":"2012-07-10 17:25:04",
        "children":null,
        "address":
        {
                "id":"3854140","line1":"105 rue de la salade ponsans","zip":"31400","town":"TOULOUSE",
                "country":"FR","rnvpStatus":"0","qualityStatus":"2","npai":false,
                "clat":"43.5675165","clong":"1.4521787"
        },
        "group":{"id":"9","codeGroup":"WWWADELYATEST","idExternal":null,"salesDescr":"Adelya","descrGroup":"test"},
        "globalGroup":"9",
        "event":{"list":null}
  }
 }

Http POST on apiv1/webapi.do?format=xml,

param : details


<FidelityMember>
    <cardnumber>10001234</cardnumber>
</FidelityMember>

The return is (show/hide)


        <FidelityMember>
        <id>3325067</id><idExternal/>
        <uniqueId>1cba11fe-b941-47ee-8ab6-598ee39de2f4</uniqueId>
        <cardnumber>10001235</cardnumber>
        <type>C</type><src>C</src>
        <gender>MME</gender><name>DUJARDIN</name><firstname>Jean</firstname>
        <login>581357</login>
        <mobile>0601020304</mobile>
        <nbPoint>0</nbPoint><cumulPoint>0</cumulPoint><nbCredit>0.0</nbCredit>
        <cumulCredit>0.0</cumulCredit><cumulCA>0.0</cumulCA><montantCA>0.0</montantCA>
        <email>jean.dujardin@test.com</email><tel/>					
        <smsoptin>false</smsoptin><emailoptin>false</emailoptin><mailoptin>true</mailoptin>
        <teloptin>false</teloptin><partneroptin>false</partneroptin>
        <sponsored>false</sponsored>
        <actif>1</actif><npei>false</npei><npmi>false</npmi><netPrice>0.0</netPrice>
        <dateCreate>2012-07-10 17:25:04</dateCreate><dateRenew>2013-07-10 00:00:00</dateRenew>
        <dateUpdate>2013-09-26 12:34:37</dateUpdate>
        <children/>
        <address>
                <id>3854140</id>
                <streetNumber/><streetType/>
                <line1>105 rue de la salade ponsans</line1><line2/>
                <zip>31400</zip><town>TOULOUSE</town>
                <country>FR</country>
                <rnvpStatus>0</rnvpStatus>
                <qualityStatus>2</qualityStatus><npai>false</npai>
                <clat>43.5675165</clat><clong>1.4521787</clong>
        </address>
        <group>
                <id>9</id><codeGroup>WWWADELYATEST</codeGroup><idExternal/><salesDescr>Adelya</salesDescr>
        </group>
        <globalGroup>9</globalGroup>
        <event>
                <list>
                        <!-- here a list of event, all the action stored on this customer -->
                </list>
        </event>
</FidelityMember>

Exemple 2

Create a new customer . Http PUT on apiv1/webapi.do

param : json_data


{
        "FidelityMember":{
        "name":"Jean",
        "firstname":"Dujardin",
        "mobile":"0601020304",
        "cardnumber":"10001235",
        "address":{         
                "line1":"105 rue de la salade ponsans",         
                "zip":"31400",
                "town":"TOULOUSE",
                "country":"FR"
                }
        }
}

The return is


{
 "ApiReturn":
  {
   "code":"OK",
   "message":null,
   "id":"3325067"
  }
 }

The status code of the operation is OK, meaning everything went ok, and no specific message or warning. And you have the primary key for your next call.

Exemple 3

Update a customer. Http PUT on apiv1/webapi.do with the member id in the data.

If you send object data to the API, that contains the object ID, then the call will be managed as an update request. For example, if the former customer wants to update his email opt-in:


    {
            "FidelityMember":{
            "id":"3325067",
            "emailoptin":"true"
            }
    }

The return is


    {
     "ApiReturn":
      {
       "code":"OK",
       "message":null,
       "id":"3325067"
      }
     }

The object ID returned is the same as before, and the object has been updated. Note that only the data changed is transmitted. If you want to empty a field, you will have to transmit the empty string. E.g. : "mobile":""

Other business objects of interest are:

AdEvent and their AdEvent Details that store all the actions made by a consummer (like buying, receiving a message, answering a survey, etc...)
Campaign and their Sent objects, for all your messages and coupons sent to a member
And many others ! You can take a look at the reference pages

Sample Code : We provide (and keep extending) a set of samples for you Here

Side note

For any further question please contact support @ adelya.com, a refence documentation is available in pdf format for registered partners.

LoyaltyOperator, LoyaltyAvenue are trademark of Adelya SAS