ShipNitro
    ShipNitro
    • Authentication
    • API v2
      • Getting Shipment Rates
        POST
      • Retrieve Shipment Details
        GET
      • Creating Shipment Labels
        POST
      • Get Current Credit
        GET
      • Getting Tracking number status
        POST
      • Address Validation
        POST
    • API v1 - deprecated do not use
      • Get Labels
        POST
      • Get Rates
        POST
      • Create Label
        POST
      • Get Current Credit
        GET
    • Callbacks
      • v2
        • Customer Create Label Callback
      • v1 - deprecated do not use
        • Callback Part 1

    Authentication

    Overview#

    This API uses API keys for authentication. The API key is a unique identifier that is used to authenticate requests associated with your organization for usage and billing purposes.

    Getting Your API Key#

    You cannot generate your own API key. To get your API key, you need to request it from the admin. The admin will generate a unique API key to your organization.

    Using Your API Key#

    Once you have an API key, you can include it in all of your API requests. The key should be included in the header of the HTTP request:
    Replace YOUR_API_KEY with the API key provided by the admin.

    Protecting Your API Key#

    Your API key carries many privileges, so be sure to keep it secure! Do not share your secret API key in publicly accessible areas such as GitHub, client-side code, and so forth.

    Conclusion#

    All API requests must be authenticated with your API key. If you do not include your API key in your requests, or if you use an incorrect or disabled API key, the API will return an error.
    Modified at 2024-06-08 00:29:34
    Next
    Getting Shipment Rates
    Built with