REST API

This module exposes several functions through the Magento REST API.

Customer Authentication

POST /rest/V1/spaaza/customer/authenticate

Parameter	Required	Description
email	Yes	The email address of the customer to test authentication for
password	Yes	The password to check
spaaza_chain_id	Depends	If Magento has been configured to use multiple Spaaza chains, this parameter is required and will be used to find the website to find the customer in.

Example

{
    "email": "info@spaaza.com",
    "password": "ThisIsEasyToGuess",
    "spaaza_chain_id": 123
}

Result

Unsuccessful

{
    "authenticated": false,
    "customer_id": null,
    "message": "Invalid login or password.",
    "website_code": null,
    "store_code": null
}

Successful

{
    "authenticated": true,
    "customer_id": 7,
    "message": null,
    "website_code": "default",
    "store_code": "default"
}

Customer Update

This endpoint can be used to create or update a Magento customer. It receives Spaaza user info and processes it in the same way as the regular data pull does (after logging in). It returns a Magento customer object.

POST /rest/V1/spaaza/customer/update

Parameter	Type	Required	Description
user_info	object	Yes	The user data as it would have been returned by the Spaaza get-user endpoint. The keys user_id, member_number, username and authentication_point_identifier are used in this specific order to identify an existing customer.
create_if_not_exists	bool	No	If true, create a new Magento customer if no customer can be identified using the provided data. Default: false.
spaaza_chain_id	int	Depends	If Magento has been configured to use multiple Spaaza chains, this parameter is required and will be used to search an existing customer in the correct website and assign to the correct website when creating a customer.
website_code	string	No	Assign a new customer to this website. Existing customers won't get updated. If spaaza_chain_id is also present, the website must be configured to use that chain id.
store_code	string	No	Assign a new customer to this store. This means that the 'new customer' email will be sent from this store. Existing customers won't get updated.

Identification

The key user_id will, if supplied, be used to identify a customer. You can then also update other Spaaza specific data like member_number. If user_id does not exist (or is considered empty by PHP) in user_info, member_number will be used to identify the customer. If using one of these two fields does not find a customer, username is tried and then as a last method authentication_point_identifier will be used.

If username or authentication_point_identifier has been used to identify the customer, user_id and member_number will be set and saved on the found customer.

Example

{
    "user_info": {
        "member_number": "99102352",
        "user_id": 3362356,
        "username": "info@spaaza.com",
        "password": "EasyOrNot?",
        "address_streetname": "Dorpstraat",
        "address_housenumber": "1",
        "address_housenumber_extension": null,
        "address_line_2": null,
        "address_line_3": null,
        "address_postalcode": "1000AA",
        "address_regionstate": null,
        "address_towncity": "Amsterdam",
        "birthday": "2002-01-01T00:00:00+00:00",
        "country_code": "NL",
        "entity_code": {
            "code": "99102352",
            "type": "custom"
        },
        "first_name": "John",
        "last_name": "Doe",
        "gender": "F",
        "id": 3362356,
        "mailing_list": {
            "mailing_list_sub_offered": true,
            "mailing_list_subscribed": true,
            "printed_mailing_list_subscribed": false
        },
        "opt_in_programme": {
            "programme_opted_in": false
        },
        "phone_number": "0851234567"
    },
    "create_if_not_exists": true,
    "spaaza_chain_id": 123
}

Result

Unsuccessful (HTTP status 404, if create_if_not_exists is false and customer is not found)

{
    "message": "Customer not found"
}

Unsuccessful (HTTP status 400, if spaaza_chain_id is not configured)

There are a lot of validations, which all return HTTP status 400 on failure.

{
    "message": "The given Chain Id is not configured in Magento."
}

Successful

{
    "id": 39,
    "group_id": 1,
    "default_billing": "8",
    "default_shipping": "8",
    "created_at": "2018-10-18 14:49:13",
    "updated_at": "2018-10-18 21:06:56",
    "created_in": "Default Store View",
    "dob": "2002-01-01",
    "email": "info@spaaza.com",
    "firstname": "John",
    "lastname": "Doe",
    "gender": 2,
    "store_id": 1,
    "website_id": 1,
    "addresses": [
        {
            "id": 8,
            "customer_id": 39,
            "region": {
                "region_code": null,
                "region": null,
                "region_id": 0
            },
            "region_id": 0,
            "country_id": "NL",
            "street": [
                "Dorpstraat",
                "1"
            ],
            "telephone": "0851234567",
            "postcode": "1000AA",
            "city": "Amsterdam",
            "firstname": "John",
            "lastname": "Doe",
            "default_shipping": true,
            "default_billing": true
        }
    ],
    "disable_auto_group_change": 0,
    "extension_attributes": {
        "is_subscribed": false,
        "spaaza_data": {
            "customer_id": 39,
            "user_id": 3362356,
            "member_number": "99102352",
            "programme_opted_in": false,
            "mailing_list_subscribed": true,
            "printed_mailing_list_subscribed": false,
            "last_hash": "deadf385f4407f78"
        }
    }
}

Customer Info By Id

GET /rest/V1/spaaza/customer/user_info/:customerId

Gets the user info for a customer as it would be sent to the Spaaza API.

Example

GET /rest/V1/spaaza/customer/user_info/1

Result

Successful

{
    "first_name": "Veronica",
    "last_name": "Costello",
    "birthday": "1973-12-15",
    "username": "roni_cost@example.com",
    "webshop_customer_id": 1,
    "gender": "F",
    "printed_mailing_list_subscribed": false,
    "mailing_list_subscribed": false,
    "mailing_list_sub_offered": true,
    "programme_opted_in": false,
    "address_streetname": "Test Street",
    "address_housenumber": "8",
    "address_housenumber_extension": "",
    "address_postalcode": "49628-7978",
    "address_towncity": "Amsterdam",
    "country_code": "NL",
    "phone_number": "010 123 45 67"
}

Unsuccessful (HTTP status 404, if customer is not found)

{
    "message": "No such entity with %fieldName = %fieldValue, %field2Name = %field2Value",
    "parameters": {
        "fieldName": "email",
        "fieldValue": "roni_cost@example.com",
        "field2Name": "websiteId",
        "field2Value": "1"
    }
}

Customer Info By Email

GET /rest/V1/spaaza/customer/user_info_by_email/:customerEmail

Gets the user info for a customer as it would be sent to the Spaaza API.

Example

GET /rest/V1/spaaza/customer/user_info/roni_cost@example.com

Result

Successful

{
    "first_name": "Veronica",
    "last_name": "Costello",
    "birthday": "1973-12-15",
    "username": "roni_cost@example.com",
    "webshop_customer_id": 1,
    "gender": "F",
    "printed_mailing_list_subscribed": false,
    "mailing_list_subscribed": false,
    "mailing_list_sub_offered": true,
    "programme_opted_in": false,
    "address_streetname": "Test Street",
    "address_housenumber": "8",
    "address_housenumber_extension": "",
    "address_postalcode": "49628-7978",
    "address_towncity": "Amsterdam",
    "country_code": "NL",
    "phone_number": "010 123 45 67"
}

Unsuccessful (HTTP status 404, if customer is not found)

{
    "message": "No such entity with %fieldName = %fieldValue, %field2Name = %field2Value",
    "parameters": {
        "fieldName": "email",
        "fieldValue": "roni_cost@example.com",
        "field2Name": "websiteId",
        "field2Value": "1"
    }
}

Unsuccessful (HTTP status 400, if customers have website sharing scope)

{
    "message": "Missing Chain Id: Customers are configured to have a website sharing scope."
}

Customer Info By Email And Spaaza Chain Id

GET /rest/V1/spaaza/customer/user_info_by_email/:spaazaChainId/:customerEmail

Gets the user info for a customer as it would be sent to the Spaaza API. Using this endpoint is necessary if Magento has been configured to use multiple Spaaza chains.

Example

GET /rest/V1/spaaza/customer/user_info/123/roni_cost@example.com

Result

Successful

{
    "first_name": "Veronica",
    "last_name": "Costello",
    "birthday": "1973-12-15",
    "username": "roni_cost@example.com",
    "webshop_customer_id": 1,
    "gender": "F",
    "printed_mailing_list_subscribed": false,
    "mailing_list_subscribed": false,
    "mailing_list_sub_offered": true,
    "programme_opted_in": false,
    "address_streetname": "Test Street",
    "address_housenumber": "8",
    "address_housenumber_extension": "",
    "address_postalcode": "49628-7978",
    "address_towncity": "Amsterdam",
    "country_code": "NL",
    "phone_number": "010 123 45 67"
}

Unsuccessful (HTTP status 404, if customer is not found)

{
    "message": "No such entity with %fieldName = %fieldValue, %field2Name = %field2Value",
    "parameters": {
        "fieldName": "email",
        "fieldValue": "roni_cost@example.com",
        "field2Name": "websiteId",
        "field2Value": "1"
    }
}