​

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:

1. Login to your dashboard or if you don’t have an existing profile with embedly, you can create an sign up on the platform.
2. Navigate to the “API & Integration” section from the sidebar.
3. Under the API Keys & Webhooks tab, click on generate secret key and then copy the secret key displayed to in the modal, please note that the secret key is a view once only function
4. Once you have the secret key, copy your clientId under the test section

​

Base URLs

Use the following base URLs for your API requests:

• Staging Environment:
  https://waas-staging.cafeone.ng/api/v1

• Production Environment:
  https://waas-prod.cafeone.ng/api/v1

​

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:

• Email: hello@embedly.ng
• Community: Join our community forum to connect with other developers.