Welcome to the Prado API Guide! Our API enables developers to seamlessly integrate with Prado's platform for managing orders, customers, subscriptions, and more. This guide will provide an overview of key features, authentication, and best practices for working with the API.

Getting Started

To begin using the Prado API, you need:

1. API Access: Ensure your merchant account has API access enabled.
2. API Key: Obtain your unique API key by navigating to Admin Classic > IT > API Keys. This key is required to authenticate all requests.
3. API Documentation: Visit our API documentation for detailed endpoints, parameters, and responses.

Base URL

The base URL for all API requests:

https://api.getprado.com/v1/

Authentication

Prado uses Bearer Token Authentication for secure API access. Include your API key in the Authorization header for each request.

Example:

Authorization: Bearer YOUR_API_KEY

Common Endpoints

1. Customers

Manage customer profiles, including creating, updating, and retrieving customer data.

• GET /customers: Retrieve a list of customers.
• POST /customers: Create a new customer profile.
• GET /customers/{id}: Retrieve a specific customer's details.

2. Orders

Create and manage orders placed by customers.

• GET /orders: Retrieve a list of orders.
• POST /orders: Create a new order.
• GET /orders/{id}: Retrieve details for a specific order.

3. Subscriptions

Handle recurring orders and subscription management.

• GET /subscriptions: Retrieve all active subscriptions.
• POST /subscriptions: Create a new subscription.
• GET /subscriptions/{id}: Retrieve details for a specific subscription.

4. Products

Access and manage your product catalog.

• GET /products: Retrieve a list of all products.
• POST /products: Add a new product.
• GET /products/{id}: Retrieve details for a specific product.

5. Reports

Generate detailed reports for orders, customers, and subscriptions.

• GET /reports/orders: Retrieve order fulfillment reports.
• GET /reports/customers: Retrieve customer activity reports.

Error Handling

Prado API uses standard HTTP status codes to indicate success or failure:

• 200 OK: Request was successful.
• 400 Bad Request: The request contains invalid parameters.
• 401 Unauthorized: Missing or invalid API key.
• 404 Not Found: The requested resource does not exist.
• 500 Internal Server Error: An error occurred on the server.

Example Error Response:

{
  "error": "Invalid API key",
  "status": 401
}

Rate Limiting

To ensure optimal performance, the API enforces rate limits:

• Default Limit: 100 requests per minute.
• Response Header: Check the X-RateLimit-Remaining header for your remaining requests.

Best Practices

• Secure Your API Key: Keep your API key confidential and rotate it periodically.
• Test in a Staging Environment: Use test data and endpoints to avoid affecting production data.
• Optimize Requests: Use filters and pagination to minimize data load and improve performance.
• Monitor API Usage: Regularly review usage metrics and adjust your integrations as needed.