> ## Documentation Index
> Fetch the complete documentation index at: https://developer.embedly.ng/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentication

> To interact with the Embedly API, you’ll need to authenticate your requests using an apikey. This key is essential for accessing the API securely and ensuring that your requests are authorized.

## Getting Your API Key

#### Staging

For testing on the staging environment, you can visit the Embedly staging dashboard here and follow the steps below to retrieve your unique staging api key:

1. **Navigate to Your Profile Settings Page:**\
   Log in to your Embedly dashboard and go to the Profile Settings section to retrieve your <Tooltip tip="An organizationId is your identification for your organization.">OrganizationId</Tooltip>.
2. **Navigate to Your API Credentials Page:**\
   Log in to your Embedly dashboard and go to the <Tooltip tip="API credentials consist of a client key and a secret key, both required for generating tokens.">APIs
   & Integration</Tooltip> section to retrieve your <Tooltip tip="An api key is essential for API authentication.">api key</Tooltip>.

Note: You can submit dummy placeholder documents, images or PDFs during your sign up and onboarding on staging. We will approve your account immediately and promptly to enable you get both your staging api key and staging organisation Id.

#### Production

To generate your apikey on production, follow these steps:

1. **Navigate to Your Profile Settings Page:**\
   Log in to your Embedly dashboard and go to the Profile Settings section to retrieve your <Tooltip tip="An organizationId is your identification for your organization.">OrganizationId</Tooltip>.
2. **Navigate to Your API Credentials Page:**\
   Log in to your Embedly dashboard and go to the <Tooltip tip="API credentials consist of a client key and a secret key, both required for generating tokens.">APIs
   & Integration</Tooltip> section to retrieve your <Tooltip tip="An api key is essential for API authentication.">api key</Tooltip>.

   <Info>
     A pre-requisite to successfully retrieving your production credentials is
     uploading all required documentation and having them approved by the
     Embedly admin
   </Info>

***

<Warning>
  You must also always pass in the **headers** of all your api request the correct api key as `x-api-key: {{you api key}}` based on the environment you are calling.
</Warning>

## Base URL

When making API requests, you'll need to use the appropriate base URL depending on the environment:

* **Production Environment:**\
  Use this URL for live, production-level operations:

  ```http theme={null}
  https://waas-prod.embedly.ng/api/v1
  ```

* **Sandbox environment:**\
  Use this URL for testing and development purposes. The sandbox environment mirrors the production environment but is intended for safe testing without affecting real data:

  ```http theme={null}
  https://waas-staging.embedly.ng/api/v1
  ```

<Info>
  Ensure that you are using the correct base URL for your environment to avoid
  unintended data manipulation or errors. For testing, always start with the
  sandbox environment before moving to production.
</Info>

<Warning>
  For security reasons, ensure that your token is stored securely and never
  shared publicly. Tokens should be refreshed regularly to maintain secure
  access to the API.
</Warning>