Noviship
  • Noviship Courier Management System
  • System Overview
    • Organizational Hierarchy
    • Concepts
  • Administration Interface
    • Shipment View
      • Timeline
    • Data Tables
      • Exporting Table Data
      • Sigmas
  • Reports
    • Designing Reports
    • Pivot Tables
    • Variables
  • Tags
    • Progress Tags
    • Tag Parameters
  • Billing
    • Reconciliation
    • Manual Invoices
    • Adjusting Shipment Price
  • Shipments
    • Shipment States
    • Pickup Requests
    • Tracking Report
  • Customer Management
    • Customize Shipment References
    • Terms & Conditions
      • Creating a Terms Document
    • Issuing API Keys
  • Rules and Standards
    • Usernames
  • Payments
    • Credit Card Processing
    • Receiving Payments
  • Address Books
    • Bulk Editing Contacts
  • Batches
    • Batch Shipment Editor
  • Integration
    • WooCommerce
      • Using the WooCommerce Plugin
      • Shipping Zones
    • Shopify
      • Installing the Noviship App
      • Configuring the Shopify Integration
      • Troubleshooting
  • Guides
    • Changing Usernames
    • Manual Reconciliation
    • Changing Shipment Status
    • Offer Report
    • Markdown
    • Refunding, Crediting and Adding Surcharges
    • Reporting on Surcharges with Pivot Tables
  • Knowledgebase
    • Difficulty Installing Zebra Printer on Windows 10
Powered by GitBook
On this page

Was this helpful?

  1. Customer Management

Issuing API Keys

Steps to follow to create an API key for a customer account.

PreviousCreating a Terms DocumentNextRules and Standards

Last updated 4 years ago

Was this helpful?

API Keys are used by the Noviship API (NSAPI) to allow third-party products to interact with the system as if they are the associated user. Users of an API key can only access data and shipments that the associated user can access and they can only perform functions granted to that user.

Issuing Keys

Go to Customers | Accounts and find the customer you want to issue the key for.

Then click on API Keys from the blue dropdown menu.

In this table you can view all the previously issued API keys. Click Add to issue a new key.

Select the user to associate the key with and check Enabled to activate it. You will see a review screen providing the key information.

You can then provide the API Key and Key Secret to your customer to use in their development or third-party product.

At this time you can ignore the Key Secret and the Authorization Header as they are only needed for our REST API which is still in development. The NSAPI does not require this information.