Skip to main content
Nemu’s API allows you to send sales events to the dashboard in real-time, expanding your application’s functionality.

​
Environments

The API is available in two environments. Each one has its own dashboard, where the API token is generated: Access to the staging dashboard requires an invite code. Contact the Nemu team to receive the code and create your account in that environment.
Use the staging environment to validate your integration before sending real sales. Generate the API token in the dashboard of the same environment you will be sending requests to: to use the staging API, generate the token at stg.dashboards.nemu.com.br.

​
Authentication

Include the dashboard token in the Authorization header of your request.

​
Generating the User Token

  1. In Nemu, go to Settings > Nemu API.
  1. Click on Generate token.
  1. Copy the displayed token.
Keep the token secure. It is unique and should only be used in authorized requests.

​
Retrieving UTMs for Integration

To send sales data with tracking information (UTMs), you must retrieve this information from one of three available sources in the following priority order:

​
Available UTM Sources

  1. Global Variable (Priority 1): window.trackingNemu.nemuUtms
    • Returns a URLSearchParams object with UTMs
    • Available when Nemu pixel is loaded on the page
  2. Cookie (Priority 2): nemuUtmsTrack
    • Cookie containing UTM information in query string format
  3. LocalStorage (Priority 3): nemu:utmsTrack
    • Local storage with UTMs in query string format

​
Fallback Strategy

The implementation should follow the priority order, trying the global variable first, then the cookie, and finally localStorage. This ensures UTMs are captured regardless of how the user arrived at the page.
The global variable window.trackingNemu.nemuUtms will only be available if Nemu pixel is loaded on the page. Use optional chaining (?) to avoid errors.

​
Sending Sales Data

The API offers two main routes to create and update orders:
  • POST /sales to create sales
  • PUT /sales/:transactionId to update sales
Make sure to include the Authorization header with your API token in all requests.