Self-Service Reference Guide

the nue io self service api provides a comprehensive suite of tools designed to streamline your revenue lifecycle processes and give you actionable insights into your financial data with the nue self service api, you can manage accounts and contacts retrieve product information and pricing details create new orders update existing asset data for subscriptions, physical assets, and entitlements automatically sync all data bidirectionally with salesforce — ensuring that any updates to accounts, contacts, orders, or subscriptions are automatically reflected in both nue io and salesforce, enabling seamless collaboration across teams built with restful principles, the api follows predictable resource oriented urls, accepts json encoded request bodies, returns json encoded responses, and uses standard http response codes and verbs in addition to the api, nue io also offers ui components that can be seamlessly integrated with these apis to simplify your build process and accelerate development these pre built ui components allow you to quickly implement customer facing interfaces, reducing the need for complex front end development licenses & permissions required the self service apis require an active self service api license to enable this license for your production and/or sandbox org, please reach out to support\@nue io mailto\ support\@nue io once the license is activated, ensure that your api keys are linked to a role with the following permission self service api access → self service api configure api keys getting started to get started with the nue io self service api and ui components, refer to the following links guides + try it out https //api docs nue io/self service a unified site that combines api guides with a "try it out" interface it provides detailed schemas, request/response examples, and step by step instructions to help you seamlessly integrate nue io's apis into your workflow ui component storybook https //nue self service ui vercel app/ a visual reference for the available ui components, showcasing interactive examples and usage details for seamless integration into your self service portal these resources will guide you through the process of integrating the apis and ui components into your application to begin using the nue self service api's, follow these steps reach out to the nue team please reach out to the nue team for access to be enabled for self service api's this involves having a self service license provisioned obtain an api key you must use a valid api key to send requests to the api endpoints this can be acquired from your nue http //nue io account settings activate permissions in nue, go to settings → roles and ensure self service api access is enabled for the relevant api key role use https the api only responds to https secured communications requests sent via http will be redirected to their corresponding https resources format of responses the api returns responses in json format if an error occurs, it will be provided in the json response under an "error" key important notes authentication the api key is required in the request header for authentication it is strongly recommended to use these apis server side rather than client side to prevent exposing your api key in frontend code, reducing the risk of unauthorized access and security vulnerabilities publish products and pricing for self service with nue, nue eliminates the need for developers to duplicate products and price information exclusively for the consumption of self service apis rev ops users use nue's price builder easy to use ui to build products and pricing, which can be of any product types, including subscriptions, physical goods, and services, and any pricing models, including recurring services, one time, overage usage, pay as you go and credit burndown these products and pricing will be available instantly for direct sales team to build quotes, orders, which are provisioned into subscriptions, assets, and service entitlements often times, the products and pricing available for self service website of a company are only a subset of that available for direct sales thereforce, nue provides a convenient way for product managers of the self service website to publish a subset of products and pricing just for self service apis to consume once this subset is published, the products and corresponding prices are shapshotted and cached within the system, ensuring access with high performance while ongoing updates by rev ops users may occur, these revisions do not impact the published version until they are explicitly republished for self service access enable a price book for self service access please follow the steps below to enable a specific price book for self service access login to nue app https //app nue io navigate to price builder → price books select the price book to enable, and click 'edit' icon click 'enable for self service' button once the price book feature is enabled, navigate to the settings page and click on webhook endpoints you’ll notice two additional webhook endpoints have been automatically created for you these endpoints are designed to sync order and subscription updates from nue to salesforce you can also view detailed logs here, including successful syncs and any failures publish a product for self service access please follow the steps below to enable a specific price book for self service access login to nue app https //app nue io navigate to price builder → product catalog select the product to publish, and click 'edit' icon click 'publish' to publish the product for self service access once a product is published for self service access, the product and its price book entries in the price book enabled for self service access will be accessible by the self service apis graphql for additional data self service scenario if the curated get api's from the postman collection don't provide all relevant details, the nue graphql model can be traversed for further information in nue, you can use nue graphqlto query any business objects you can use nue graphql to query the customer, contact, order, and invoice created graphql endpoint https //api nue io/orders/async/graphql query customers the following is an example query { customer(where {id { eq "02e24cf3 40d6 43b2 a47b 53904ab3776c"}}) { createdbyid createddate id lastmodifiedbyid lastmodifieddate name phone } } query contacts the following is an example query { contact { billingcity billingcountry billingstate billingstreet billingzipcode birthday createdbyid createddate customerid email firstname id lastmodifiedbyid lastmodifieddate lastname middlename mobilephone name shippingcity shippingcountry shippingstate shippingstreet shippingzipcode suffix } } query order history the following is an example to query all active orders sorted by order activation dates and total amounts query { order( where {status { eq "activated"}} orderby {activateddate asc, totalamount asc} ) { customer { id name totaltcv todayarr todaycmrr } activatedbyid activateddate billcycleday billtocontactid billingaccountid billingaddress billingperiod companyauthorizedbyid companyauthorizeddate createdbyid createddate customerauthorizedbyid customerauthorizeddate customerid description discount discountamount enddate id lastmodifiedbyid lastmodifieddate listtotal name nextinvoicedate opportunityid orderacv ordernumber orderplaceddate orderreferencenumber orderstartdate ordertcv ordertype originalorderid ownerid podate ponumber pricebookid shiptocontactid shippingaddress shippingandhandling status subscriptionstartdate subscriptionterm subtotal systemdiscount systemdiscountamount tax todayarr todaycmrr totalamount totalprice } } query subscriptions the following is an example to query all active subscriptions sorted by products and subscription start dates query { subscription( where { and \[{status { eq "active"}}, {customer {id { eq "{{customerid}}"}}}]} orderby {productid asc, subscriptionstartdate asc} ) { actualsubscriptionterm autorenew billingperiod billingtiming bundled cancellationdate createdbyid createddate customerid id includedunits lastmodifiedbyid lastmodifieddate lastversionedsubscriptionid latestversionedsubscriptionid listprice name orderondate orderproductid originalsubscriptionid pricebookentryid pricebookid productid quantity reconfigureeffectivedate renewalterm rootid salesprice status subscriptionenddate subscriptionlevel subscriptionstartdate subscriptionterm subscriptionversion taxamount tcv todayarr todaycmrr todaysquantity totalacv totalamount totalprice totaltcv uomid } }