Nue Self-Service API GuideCopied!

OverviewCopied!

The Nue.io Self-service API provides a comprehensive suite of tools and resources to empower businesses to streamline their revenue lifecycle processes and gain actionable insights into their financial data.

• Manage accounts and contacts

• Retrieve product information and pricing details

• Create new orders

• Create orders to update existing asset data for subscriptions, physical assets, and entitlements

Designed with RESTful principles, our API offers predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.

Getting StartedCopied!

To begin using the Nue Self-Service API, follow these steps:

1. Reach out to the Nue Team: 
   Please reach out to the Nue team at support@nue.io for access to be enabled for self service API's. This involves provisioning a Self Service license.

2. 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.io account settings.

3. Activate Permissions: In Nue, go to Settings → Roles and ensure Self Service API Access is enabled for the relevant API key Role.

4. Understand Rate Limits: Be aware of the rate and usage limits associated with your API key to ensure smooth operation.

5. Use HTTPS: The API only responds to HTTPS-secured communications. Requests sent via HTTP will be redirected to their corresponding HTTPS resources.

6. 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 Note on API Key Usage

Since the API key is required in the request header for authentication, it is recommended that these APIs be used in server-side code rather than in frontend applications. This helps prevent exposing your API key in client-side code, which can lead to unauthorized access and potential security vulnerabilities.