id
and auth_id
are 2 different fields and are not interchangeable. auth_id
can be set by you if you register users using our Loyalty API. So, for example, you could set it to the primary key you have for the user in your own systems. This saves you the trouble of creating another column to map users in your system to the user profile with qiibee.auth_id
field empty and we will generate a UUID-v4 and return it to you so you can save it in your system. The user_id
shown in the Loyalty Whitelabel App (LWA) frontend is different from the auth_id
and is used exclusively for the LWA frontend.POST /users
auth_id
for every new user registration so you can map each user to your internal system. If you do not send this field we will generate a UUID-v4 and return it to you. auth_id
and use it for all actions on a user's account.HTTP 201
with the user objectHTTP 400
with error messageauth_id
PUT /users/:auth_id
|| PATCH /users/:auth_id
auth_id
HTTP 200
with the user objectHTTP 404
with error messageGET /users/
limit
: (optional) sets the required limit of users history to be requested.100
100
offset
: (optional) number of users to offset when getting the remaining users. 0
HTTP 200
with the user object:HTTP 404
with error messageGET /users/:auth_id
HTTP 200
with the user object:HTTP 404
with error messagePOST /users/:auth_id/memberships
exchange_provider_implementation_name
can be one of:etihad
miles_and_more
HTTP 201
with the user objectHTTP 404
HTTP 400
with error messageGET /users/:auth_id/memberships
GET /users/:auth_id/memberships/:implementation_name
404
and empty object otherwise. HTTP 200
with membershipHTTP 404
if user or membership not foundDELETE /users/:auth_id/memberships/:implementation_name
404
if user or membership not found. HTTP 204
HTTP 404
if user or membership not foundHTTP 400
if the implementation does not exist