Getting Started
Welcome to the Gemini Commerce API documentation. This guide will help you get started with our APIs by introducing key concepts, basic configurations, and an overview of the services we provide.
Overview
Gemini Commerce APIs allow you to integrate with our platform to enhance your application’s capabilities. Whether you are building a new integration or managing an existing system, our APIs provide the flexibility and tools you need.
This documentation includes:
- Authentication: How to securely access the APIs.
- Rate Limits: Understand API usage limits.
- Business Domains: Explore the available domains and their functionalities.
Key Concepts
Authentication
All requests to Gemini Commerce APIs require a valid JWT token for authentication. Here’s a quick overview of the process:
- Authenticate using your
tenantId,loginId, andpasswordvia the Login API. - Include the
Authorizationheader in all subsequent requests:Authorization: Bearer <your-token> - Renew your token when it expires. APIs will respond with 401 Unauthorized if the token is invalid or expired.
For detailed steps, see the Authentication Guide.
Rate Limits
To maintain stability and fairness across our platform, some Gemini Commerce APIs are subject to rate limitations. Here are the details:
- REST API Limits: The REST API is limited to 8 requests per second per tenant.
- Calls from multiple clients for the same tenant are aggregated.
- Exceeding this limit results in an
HTTP 429 Too Many Requestserror. Requests will succeed again after a one-second interval.
- Request-based Limits: All requests are weighted equally, regardless of the amount of data retrieved.
For more information, see the Rate Limits Guide.
Best Practices for Managing Limits
- Optimize your code to retrieve only the necessary data.
- Implement error-handling to gracefully manage throttling errors.
- Pause additional API requests for at least 1 second before retrying.
Business Domains
Gemini Commerce APIs are structured into various business domains, each serving a specific purpose. Explore the domains below to understand their functionalities and usage:
- Authentication: Manage user authentication and token generation.
- DAM (Digital Asset Management): Upload, manage, and retrieve digital assets.
- DXP (Digital Experience Platform): Manage digital experience configurations and content delivery.
- PIM (Product Information Management): Create, update, and retrieve product details, metadata, and configurations.
- AI Product Data Enhancer: Enhance and generate product data using AI.
- CDP (Customer Data Platform): Manage customer data aggregation and segmentation.
- OMS (Order Management System): Handle order cre ation, status updates, and retrieval of order details.
- Inventory: Track and manage inventory levels.
- Pricelist: Manage pricing information, discounts, and currency-specific rates.
- Search: Perform search queries and retrieve indexed data.
- Promotions: Create and manage promotional campaigns.
- Webhook Registry: Register and manage webhooks for event-driven workflows.
Next Steps
- Read the Authentication Guide: Learn how to authenticate with the APIs.
- Review Rate Limits: Understand API usage limits and best practices.
- Explore Domains: Visit the detailed API documentation for each business domain.
Support
If you encounter any issues or need help, feel free to reach out to our support team:
- Email: support@gemini-commerce.com
- Documentation: Explore other guides and FAQs.
Ready to get started? Head to the API Reference and start building!