Skip to main content

​
API Reference & Overview

Welcome to the Embedly API documentation! This page provides everything you need to integrate with the Embedly API, including setup instructions, authentication details, and detailed endpoint documentation with interactive playgrounds to test your requests.

​
Get Started

​
Retrieve Your API Key

To access the full Embedly API services, you’ll need an API key. Follow these steps to retrieve it from your dashboard:

​
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

​
Base URLs

Use the following base URLs for your API requests:
Ensure you’re using the correct base URL for your environment. Requests to the production environment require a valid API key.

​
Authentication

All API requests require your API key to be passed as a header. Include the following header in every request: Header Example: 
x-api-key: {{API-KEY}}

​
API Endpoints

The Embedly API provides a powerful set of tools to manage organizations, customers, wallets, products, and more. Explore the following endpoint categories:
  • Authentication: Authenticate with the API to obtain a token.
  • Country: Create and add Countries
  • Currency: Manage currency-related operations.
  • Customer: Create, update, and retrieve customer information.
  • Product: Create and manage products.
  • ProductLimit: Set limits on products and customers.
  • Wallet: Manage wallets, transactions, and restrictions.
  • WalletGroup: Organize wallets into groups and manage features.
The Embedly API uses standard HTTP status codes to indicate the success or failure of a request. Common error responses include:

​
Error Handling

The Embedly API uses standard HTTP status codes to indicate the success or failure of a request. Common error responses include:
  • 401 Unauthorized: Invalid or missing API key.
  • 404 Not Found: The requested resource does not exist.
  • 500 Internal Server Error: An unexpected error occurred on the server.
Each endpoint’s documentation includes specific error responses and examples.

​
Need Help?

If you encounter issues or have questions, reach out to our support team: