Nue Knowledge Center

Nue Docs navigation

Get Started

Configure Products and Prices Create Quotes and Orders Upsell and Renew Subscriptions Understanding Price Calculations Understanding Subscription Term Basis and Proration Ask Nue!

Use Cases

Authenticate API Users Refresh the Salesforce Sandbox

Price Builder

Products Price Book Unit of Measure (UOM)Price and Discount Tags Product Bundle Product Group Product Relationships Percent of Total Multi-attribute Pricing Multiple Currencies Manage Custom Attributes in Price Book Entries Quantity Tier Attributes for Price Tags

Object Model

Nue Object Model Overview Nue Object Model - Price Builder Nue Object Model - Lifecycle Manager Nue Object Model - Billing and Usage Accelerator Understanding Line Types Nue Object Model - Revenue Lifecycle Intelligence

Tutorial

Price Builder Quote Builder Lifecycle Manager Collections Everything Billing Usage Accelerator Lifecycle Intelligence The Nue Platform Integrations Frequently Asked Questions

Lifecycle Manager

Configure Renewal Opportunity Process Configure Create Opportunity Popup Import Subscriptions into Nue Nue Sales Console

Quote Builder

Quote Builder Overview Quote and Order Split Quote Approval Sync Primary Quote to Opportunity Template Quote Manage Filters

Lifecycle Manager

Lifecycle Manager Overview Upsell and Downsell Renew Subscriptions Co-Term Subscriptions Cross-Sell Reconfigure Bundle Subscriptions Adjust Prices Evergreen Subscriptions Cancel Subscriptions Cancel Orders Preview Invoices Manage Service Milestones and Milestone-based Billing

Nue Platform

Manage Custom Fields Product Search Plugin Lookup Filter Plugin Default Value Plugin Invoice Preview Plugin Query Nue Objects using GraphQL Price Tag Search Plugin

Use Cases

Subscription Ramp Pricing Configure Pricing for Different Billing Periods Billing Account Search Setting a Price Floor Revenue Sharing with Partners Custom Payment Terms Update Order Information Customize Auto-numbering Schemes

Everything Billing

Billing Accelerator Overview Billing Parameters Billing Schedules Invoice Status Explained Credit Memos Late Fees - a Debit Memo Use Case Catch-up Bill Run Billing Account Hierarchy Scheduled Sync Jobs Billing Groups Multiple Entities

Collections

Collections Overview Collections Scenarios - Invoicing Collections Scenarios - Credit Memos and Debit Memos Collections Scenarios - Payments Collections Scenarios - Refunds and Reversals Collections Scenarios - Write Off Payment Rules

How-to Guide

Lifecycle Manager Nue Platform

Usage Accelerator

Usage Accelerator Overview The Credit Burndown Usage Model Multiple Credit Pools Credit Proration One-time Credits Integrate with Existing Usage Systems

Developer Resources

Use Cases Object Model API Reference Apex Global Services Self-Service API Guide Client Side Pricing Engine

Lifecycle Intelligence

Revenue Lifecycle Intelligence Subscription and Order Metrics ARR Momentum Booking Dashboard Pipeline Dashboard Billing and Collections Dashboard

Support

Submit a support ticket

The Nue Platform

System Settings Platform Settings Lifecycle Manager Settings Price Builder Settings Billing and Usage Settings Nue Security API Keys Roles and Permissions Export and Import Understanding Data Storage and Synchronization

Integrations

Nue on Salesforce Nue on Salesforce Permission Sets Stripe Integration DocuSign Integration QuickBooks Integration NetSuite Integration - ARM Connector Recognize Revenue via RightRev Calculate Taxes via Avalara Integration Calculate Taxes via Stripe Tax Webhooks Update Nue Integration User for Salesforce Integration Nue on Salesforce Layout Configurations NetSuite Integration v2023 NetSuite Integration Setup NetSuite Connector - Fields Mapping Streamlined E-Invoicing with Avalara ELR

Home

Tutorial/The Nue Platform

API Keys

An API key serves as a unique identifier and authentication token used to access and interact with an application programming interface (API). It acts as a passcode, allowing authorized users or applications to make requests to the API securely. API keys are commonly used to authenticate API requests, ensuring that only authorized users or systems can access the API's functionality and data. They provide a simple and effective way to manage access control and track usage of API resources.

It's recommended to utilize API keys for authenticating API requests to Nue. When a request lacks a valid API key, Nue will respond with an error indicating the request is invalid. If a request contains a deleted or expired key, Nue will return an authentication error. Additionally, Nue automatically generates a default API key for each tenant. Furthermore, Nue's integration with Salesforce, Stripe, and QuickBooks relies on a master API key for making callouts to Nue actions.

PERMISISONS REQUIRED

The following functional permissions are required to configure API Keys:

Security

View API Keys
Manage API Keys

Configure API Keys

Please follow the steps below to acquire API keys:

Login to Nue App
Click on Settings → In the Settings Search Box, search for 'API Keys'

Reveal an API Key

Mouse over the API Key column and click on the "Reveal" button
Enter your login password to reveal the key for security purposes
Click to copy the API key to the clipboard

Authenticate Nue API Request with API Key

After the API key is copied to the clipboard, paste the API key to the request header as follows:

(Replace {{new-api-key}} with the pasted API Key)

POST /revenue/async/graphql
Host: api.nue.io
Content-Type: application/json
nue-api-key: {{nue-api-key}}

In Postman:

You now have the capability to utilize Nue APIs by employing the API key. The accessibility to resources is determined by the permissions assigned to the API key.

Rotate API Keys

For enhanced security measures, it's recommended to rotate an API key regularly or once it's deemed compromised. Rotating an API Key makes the current key invalid and generates a new one. You have the choice to rotate the API Key instantly or create a replacement key and then revoke the original one after a specified period.

To rotate the key, simply click on the "Rotate API Key" action icon. If there's a Expiration Date displayed below the key name, it means the key can't be rotated further. Keys already expired won't be visible in the API Key list anymore. You can still access the request logs of the previous key using the replacement key. When you rotate the key, the new one becomes immediately operational, regardless of the expiration time of the old key. Opting for "Now" as the Expiration Time will instantly expire the original key.

Use API Key in Salesforce

It is recommended to use API Key in Salesforce to access Nue, especially in the following scenarios:

When Multi-Factor Authentication (MFA) is enabled in Nue;
When you have a need to integrate Nue with an external system from Salesforce.

To use Nue API Key in Salesforce, please follow the steps below:

Configure API Key in External Credentials
Add Principal into Permission Set
Change Custom Settings

Configure API Key in External Credentials

Please follow the steps below to configure the API Key:

Navigate to Setup and search Named Credentials
Click External Credentials
Click to open Nue External Credentials

In the Principals section, click 'Edit' in the Actions to edit the API Key parameter.
In the Modal Popup of 'Edit Principal', click Add to add a new Authentication Parameter.
- Enter the name exactly as: ApiKey
- Paste the API Key
- Click 'Save'.

Update Custom Setting

Please follow the steps below to configure System Settings:

1. Navigate to Setup → Custom Settings → Nue System Setting, and click Manage

2. Select NuePlatformNameCredential, and click Edit

3. Change the Row Value to Ruby__NuePlatformBuilder and then click Save.

Add Named Principals in the Permission Set

After successfully configuring the Named Principal that includes the API Key, you must include it in a designated permission set.

1. Navigate to Permission Sets and select a permission set, for example, Nue Custom System Administrator, which is a clone of Nue System Administrator permission set.

2. Select External Credential Principal Access, and click Edit

2. Move "NueExternalCredentials - API Key" to the Enabled colume, and click Save.