This page lists all available REST APIs for the Nexway Monetize platform.
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 |
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 |
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 |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
createDiscount |
POST /discounts |
Discount | Create a discount |
getOne |
GET /discounts/{idOrCode} |
Get a discount | |
getAllDiscounts |
GET /discounts |
Get list of discounts | |
generateSingleUseCodes |
POST /discounts/{id}/generate |
SingleUseCodeGenerationRequest | Generate coupons |
updateDiscount |
PUT /discounts/{id} |
Discount | Update a discount |
declareUsages |
POST /discounts/usages |
DiscountUsageDeclaration | Declare discount usages |
applyDiscountsOnCart |
POST /discounts/discount/cart |
Cart | Apply discounts on cart |
applyDiscountsOnAProduct |
POST /discounts/discount/product |
Product | Apply discounts on a product |
deleteDiscount |
DELETE /discounts/{id} |
Delete a discount | |
importDiscount |
POST /discounts/import |
Discount | Import a discount |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
getProduct |
GET /products/{id} |
Get a product by id | |
createProduct |
POST /products |
Product | Create a product |
getAllProducts |
GET /products |
Get list of products | |
updateProduct |
PUT /products/{id} |
Product | Update a product |
getNextGeneration_1 |
GET /products/{id}/nextgeneration |
Get the next generation of product | |
deleteProduct |
DELETE /products/{id} |
Delete a product | |
getVariantMatrix |
GET /products/{id}/variants/matrix |
Get the matrix | |
importProduct |
POST /products/import |
Map | Import a product |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
createProductRecommendation |
POST /product-recommendations |
ProductRecommendation | Create a product recommendation |
getProductRecommendation |
GET /product-recommendations/{id} |
Get a product recommendation by id | |
updateProductRecommendation |
PUT /product-recommendations/{id} |
ProductRecommendation | Update a product recommendation |
getAllProductRecommendations |
GET /product-recommendations |
Get a list of product recommendations | |
deleteProductRecommendation |
DELETE /product-recommendations/{id} |
Delete a product recommendation | |
getRecommendations |
GET /product-recommendations/request |
Get recommendations | |
importRecommendation |
POST /product-recommendations/import |
ProductRecommendation | Import a recommendation |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
getCatalog |
GET /catalogs/{id} |
Get a catalog by id | |
createCatalog |
POST /catalogs |
AbstractCatalog | Create a catalog |
createFullCatalog |
POST /catalogs/createFullCatalog |
FullCatalog | Create a full catalog |
getAllCatalogs |
GET /catalogs |
Get a list of catalogs | |
updateCatalog |
PUT /catalogs/{id} |
AbstractCatalog | Update a catalog |
deleteCatalog |
DELETE /catalogs/{id} |
Delete a catalog |
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 |
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 |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
createVariable |
POST /tandcs/variables |
TemplateVariable | Create a template variable |
getTandC_2 |
GET /tandcs/tandcs/{platform}/{customerId}/current |
Get a T&C | |
createTandCTemplate |
POST /tandcs/templates |
Template | Create a template |
getAllVariables |
GET /tandcs/variables |
Get a list of template variables | |
getTandCTemplate |
GET /tandcs/templates/{id} |
Get a template by id | |
updateVariable |
PUT /tandcs/variables/{id} |
TemplateVariable | Update a template variable |
getAllTandC |
GET /tandcs/tandcs |
Get a list of T&C | |
getTandC |
GET /tandcs/public/tandcs/{customerAndPlaftormId}/{locale} |
Get a terms and conditions by customer Id and locale | |
getTandC_1 |
GET /tandcs/public/tandcs/{platform}/{customerId}/{locale} |
Get a terms and conditions by plaform and customer Id and locale and etc | |
getAllTandCTemplate |
GET /tandcs/templates |
Get a list of templates | |
deleteVariable |
DELETE /tandcs/variables/{id} |
Delete a template variable | |
updateTandCTemplate |
PUT /tandcs/templates/{id} |
Template | Update a template |
deleteTandCTemplate |
DELETE /tandcs/templates/{id} |
Delete a template | |
processSampleTandCTemplate |
POST /tandcs/templates/{id}/processsample |
TemplateString | Process sample of template |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
getAllOrders |
GET /orders |
Get list of orders | |
getOrder |
GET /orders/{id} |
Get an order by ID | |
getOrderEmail |
GET /orders/{id}/emails/{emailId} |
Get an email of an order | |
cancelOrder |
POST /retention/cancel |
Cancel Payload | Cancel an order |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
createEnduser |
POST /endusers |
EndUser | Create a new end-user |
getEnduser_2 |
GET /endusers/{id} |
Get an end-user by ID | |
updateEnduser |
PUT /endusers/{id} |
EndUserPut | Update an end-user |
getAllEndusers |
GET /endusers |
Get list of end-users | |
importEndUserUsingPOST |
POST /endusers/import |
EndUserImport | importEndUser |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
contactCustomerCare |
POST /endusers/public/customercare |
CustomerCareRequest | End-user: Contact Customer Care |
getEnduserToken |
POST /endusers/public/login |
LoginRequest | End-user: Login request |
initEnduserPassword |
PUT /endusers/public/initpassword/{passwordToken} |
PasswordModification | End-user: Initialize password |
resetEnduserPassword |
POST /endusers/public/resetpassword |
ResetPasswordRequest | End-user: Request password reset |
updateEnduserPassword_1 |
PUT /endusers/public/updatepassword/{token} |
PasswordModification | Update end-user password |
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 |
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 | |
getPublicAllProducts |
GET /products/public |
Get all product entries via public context | |
getPaymentToken |
GET /purchases/public/token |
Get payment token | |
processPurchase |
POST /purchases/public |
Purchase | Create a new purchase and process it |
updateCart |
PUT /carts/public/{id} |
CartPut | Update a cart |
getPublicProduct |
GET /products/public/{id} |
Get a product by id via public context | |
getNextGeneration |
GET /products/public/{id}/nextgeneration |
Get the next generation of product via public context |
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 |
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 |
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 |
Operation | HTTP Request | Resource Request | Description |
---|---|---|---|
getPriceFunction |
GET /products/price-functions/{id} |
Get a price function by ID | |
createFunction |
POST /products/price-functions |
PriceFunction | Create a price function |
updatePriceFunction |
PUT /products/price-functions/{id} |
PriceFunction | Update a price function |
getAllPriceFunctions |
GET /products/price-functions |
Get list of price functions | |
deletePriceFunction |
DELETE /products/price-functions/{id} |
Delete a price function |
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 |