Nexway Monetize: Specification summary

This page lists all available REST APIs for the Nexway Monetize platform.

JWT Authentication

Operation	HTTP Request	Resource Request	Description
getUserToken	POST /iam/tokens	TokenRequest	Get/refresh a token
invalidateToken	DELETE /iam/tokens/invalidate		Invalidate a token
resetUsingDELETE	DELETE /iam/tokens/reset		reset

Manage Users

Operation	HTTP Request	Resource Request	Description
createUser	POST /iam/users	User	Create a user
getUser	GET /iam/users/{id}		Get a user by id
getAllUsers	GET /iam/users		Get list of users
updateUser	PUT /iam/users/{id}	UserUpdate	Update a user
deleteUser	DELETE /iam/users/{id}		Delete a user

Manage Customers

Operation	HTTP Request	Resource Request	Description
getCustomer	GET /customers/{id}		Get a customer by id
getCustomerByName	GET /customers/name/{name}		Get a customer by name
getCustomerByRealmName	GET /customers/realm/{name}		Get a customer by realm name

Manage Discounts

Operation	HTTP Request	Resource Request	Description
createDiscount	POST /discounts	Discount	Create a discount
generateSingleUseCodes	POST /discounts/{id}/generate	SingleUseCodeGenerationRequest	Generate coupons
updateDiscount	PUT /discounts/{id}	Discount	Update a discount
getAllDiscounts	GET /discounts		Get a list of discounts
declareUsages	POST /discounts/usages	DiscountUsageDeclaration	Declare the usages of discounts
applyDiscountsOnCart	POST /discounts/discount/cart	Cart	Apply discounts on a cart
applyDiscountsOnAProduct	POST /discounts/discount/product	Product	Apply discounts on a product
deleteDiscount	DELETE /discounts/{id}		Delete a discount
getOne	GET /discounts/{idOrCode}		Get a discount

Manage Products

Operation	HTTP Request	Resource Request	Description
createProduct	POST /products	Product	Create a product
getProduct	GET /products/{id}		Get a product by id
getAllProducts	GET /products		Get list of products
updateProduct	PATCH /products/{id}	ProductUpdate	Update a product
getNextGeneration_1	GET /products/{id}/nextgeneration		Get the next generation of product
deleteProduct	DELETE /products/{id}		Delete a product
deleteProductCountry	DELETE /products/{id}/prices/{country}		Delete a country from a product
deleteProductVariable	DELETE /products/{id}/variable/{variable}		Delete a variable from a product
deleteProductLocale	DELETE /products/{id}/description/{locale}		Delete a locale from a product
putUsingPUT	PUT /products/{id}	ProductUpdate	put

Manage Stores

Operation	HTTP Request	Resource Request	Description
createStore	POST /stores	Store	Create a store
getStoreByHostname	GET /stores/hostname/{hostname}		Get a store by hostname
getStore_1	GET /stores/{id}		Get a store by id
getAllStores	GET /stores		Get list of stores
updateStore	PUT /stores/{id}	Store	Update a store
deleteStore	DELETE /stores/{id}		Delete a store

Manage Carts

Operation	HTTP Request	Resource Request	Description
getCart	GET /carts/{id}		Get a cart by id
getAllCarts	GET /carts		Get list of carts
deleteCart	DELETE /carts/{id}		Delete a cart

Manage Orders

Operation	HTTP Request	Resource Request	Description
getOrder	GET /orders/{id}		Get an order by id
getAllOrders	GET /orders		Get list of orders
getOrderEmail	GET /orders/{id}/emails/{emailId}		Get an email of an order
cancelOrder	POST /retention/cancel	Cancel Payload	Cancel an order

Manage Endusers

Operation	HTTP Request	Resource Request	Description
createEnduser	POST /endusers	EndUser	Create a new enduser
getEnduser_2	GET /endusers/{id}		Get an enduser by id
getEnduserByStoreAndEmail	GET /endusers/{storeId}/{email}		Get an enduser by store and email
getAllEndusers	GET /endusers		Get list of endusers
updateEnduser	PUT /endusers/{id}	EndUserPut	Update an enduser
updateEnduserPassword	PUT /endusers/updatepassword/{token}	PasswordModification	Update enduser's password

Enduser account APIs

Operation	HTTP Request	Resource Request	Description
getEnduserToken	POST /endusers/public/login	LoginRequest	Enduser: Login request
resetEnduserPassword	POST /endusers/public/resetpassword	ResetPasswordRequest	Enduser: Request reset password
initEnduserPassword	PUT /endusers/public/initpassword/{passwordToken}	PasswordModification	Enduser: Initialize password
updateEnduserPassword_2	PUT /endusers/public/updatepassword/{token}	PasswordModification	Update enduser's password
contactCustomerCare	POST /endusers/public/customercare	CustomerCareRequest	Enduser: Contact Customer Care

Marketing services

Operation	HTTP Request	Resource Request	Description
dmpFeed	POST /event	Event	Send information about an end-user (generic end-point)
dmpQuoteTransmitter	POST /quotes	EndpointQuoteParameter	Submit a quote request

Shopper APIs

Operation	HTTP Request	Resource Request	Description
createCart	POST /carts/public	CartInput	Create a cart
getPaymentMethodsForCart	GET /carts/public/{id}/paymentmethods		Get Payment Methods For Cart
getPublicCart	GET /carts/public/{id}		Get a cart by id
updateProductsInCart	PUT /carts/public/{id}/products	ProductUpdate	Update products to a cart
verifySignedData	POST /customers/public/{id}/verify	SignedRequest	Verify the signed data
getStore	GET /stores/public/{id}		Get a store by id
getNextGeneration	GET /products/public/{id}/nextgeneration		Get the next generation of product via public context
getPublicProduct	GET /products/public/{id}		Get a product by id via public context
getPublicAllProducts	GET /products/public		Get all product entries via public context
updateCart	PUT /carts/public/{id}	CartPut	Update a cart
getPaymentToken	GET /purchases/public/token		Get payment token
processPurchase	POST /purchases/public	Purchase	Create a new purchase and process it
getVariantMatrix	GET /products/public/{id}/variants/matrix		Get the matrix

Manage Notifications

Operation	HTTP Request	Resource Request	Description
createNotifierRules	POST /customer-notifier/rules	Rules	Create notification rules
getNotifierRules	GET /customer-notifier/rules/{id}		Get a set of notification rules by id
getAllNotifierRules	GET /customer-notifier/rules		Get list of notification rules
updateNotifierRules	PUT /customer-notifier/rules/{id}	Rules	Update a notification rule
deleteNotifierRules	DELETE /customer-notifier/rules/{id}		Delete a set of notification rules
getEventHistory	GET /customer-notifier/history		Get history of notified events

Fulfillment sample Server

Operation	HTTP Request	Resource Request	Description
licensesNew	POST /sample-fulfillment-provider/licenses/new	LicenseRequest	Get a new activation code
licensesCancel	POST /sample-fulfillment-provider/licenses/cancel	LicenseRequest	Cancel the given activation code
licensesRenew	POST /sample-fulfillment-provider/licenses/renew	LicenseRequest	Get a new sample activation code
licensesSuspend	POST /sample-fulfillment-provider/licenses/suspend	LicenseRequest	Suspend the given activation code
licensesReactivate	POST /sample-fulfillment-provider/licenses/reactivate	LicenseRequest	Reactivate the given activation code
licensesPause	POST /sample-fulfillment-provider/licenses/pause	LicenseRequest	Pause the given activation code

Api Price Function Command

Operation	HTTP Request	Resource Request	Description
createFunction	POST /products/price-functions	PriceFunction	Create a price function
getPriceFunction	GET /products/price-functions/{id}		Get a price function by id
updatePriceFunction	PUT /products/price-functions/{id}	PriceFunction	Update a price function
deletePriceFunction	DELETE /products/price-functions/{id}		Delete a price function
getAllPriceFunctions	GET /products/price-functions		Get list of price functions

Signed Data Api Command

Operation	HTTP Request	Resource Request	Description
getBlacklistedSignedData	GET /customers/blacklistedsigneddata/{blacklistItemId}		Get a blacklisted signed data by id
verifySignedDataWithJWT	POST /customers/verify	SignedRequest	Verify the signed data with JWT
signData	POST /customers/{customerId}/sign	Data	Sign data
signWithJWT	POST /customers/sign	Data	Sign data with JWT

User Public Command

Operation	HTTP Request	Resource Request	Description
resetUserPassword	POST /iam/users/public/resetpassword/{realm}/{token}	UserCredential	Reset a password
checkPasswordToken	POST /iam/users/public/checkpasswordtoken/{realm}/{token}		Check validity of password token
lostUserPassword	POST /iam/users/public/lostpassword/{realm}	LostPassword	lost password