Skip to main content

​
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 .
  2. Navigate to Your API Credentials Page:
    Log in to your Embedly dashboard and go to the section to retrieve your .
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 .
  2. Navigate to Your API Credentials Page:
    Log in to your Embedly dashboard and go to the section to retrieve your .
    A pre-requisite to successfully retrieving your production credentials is uploading all required documentation and having them approved by the Embedly admin
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.

​
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:     
    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:     
    https://waas-staging.embedly.ng/api/v1
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.
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.