Firstbase API
  • INTRODUCTION
    • REST API
    • Use Cases
      • User Management
      • Asset Management
      • Catalog and Ordering
  • GETTING STARTED
    • Generating your API Key
    • Authentication
    • Making requests
    • Pagination
    • Rate Limiting
    • Deprecations - WIP
    • Filtering - WIP
  • API Reference
    • Catalog
      • Skus
    • Inventory
      • Tags
      • Assignment
      • Archive
    • Orders
    • Shipments
    • Packages
    • Users
    • Specification
Powered by GitBook
On this page
  1. GETTING STARTED

Authentication

Lets talk about how to authenticate requests the API and handling any errors

To access the Firstbase API, you must authenticate each request by including a valid API key. API key-based authentication ensures that only authorized users can interact with the API. Without this key, requests will be denied.

Every API request requires the Authorization header with your API key. When making API requests, include the API key in the request header using the following format:

Authorization: ApiKey YOUR_API_KEY_HERE

Replace YOUR_API_KEY with the key you generated from your Firstbase account. This key provides access to your account’s data, so it’s essential to keep it secure.

Handling Authentication Errors

If authentication fails, the API will return a 401 Unauthorized error. This occurs if the Authorization header is missing, the API key is incorrect, or the key has been revoked. In order to resolve this, follow these steps:

  • Double-check that the API key is correct and properly formatted.

  • Ensure the Authorization header is included in every request.

  • Verify that the key hasn’t been deleted or expired.

PreviousGenerating your API KeyNextMaking requests

Last updated 7 months ago