{ "info": { "_postman_id": "gen-endpoint-public-apis", "name": "Gen-Endpoint Public REST APIs", "description": "Official Postman Collection for Gen-Endpoint.com. 23+ free public REST endpoints for prototyping, automated integration testing, and mock responses.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://gen-endpoint.com", "type": "string" } ], "item": [ { "name": "Greeting API", "description": "A versatile API for generating greeting messages. Supports simple GET requests and POST requests with data.", "item": [ { "name": "Returns a generic greeting message with API version.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/greeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "greeting" ], "query": [] }, "description": "Returns a generic greeting message with API version." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/greeting" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\": \"Hello from our API!\", \"version\": \"1.0.0\", \"timestamp\": \"2024-08-15T10:00:00.000Z\"}" } ] }, { "name": "Returns a personalized greeting message using a query parameter.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/greeting?name=Alice", "host": [ "{{baseUrl}}" ], "path": [ "api", "greeting" ], "query": [ { "key": "name", "value": "Alice" } ] }, "description": "Returns a personalized greeting message using a query parameter." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/greeting?name=Alice" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\": \"Hello, Alice, from our API!\", \"personalized\": true, \"timestamp\": \"2024-08-15T10:01:00.000Z\"}" } ] }, { "name": "Receives a name in the JSON body and returns a custom greeting.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bob\",\n \"preferences\": {\n \"formal\": false\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/greeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "greeting" ], "query": [] }, "description": "Receives a name in the JSON body and returns a custom greeting." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/greeting" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\": \"Greetings, Bob! Your POST request was received.\", \"confirmationId\": \"post-12345\", \"receivedData\": {\"name\": \"Bob\", \"preferences\": {\"formal\": false}}, \"timestamp\": \"2024-08-15T10:02:00.000Z\"}" } ] } ] }, { "name": "System Status API", "description": "Provides the current operational status, version, and timestamp of the application. Ideal for health checks and monitoring.", "item": [ { "name": "Returns the current system status, service name, uptime (illustrative), and a timestamp.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "status" ], "query": [] }, "description": "Returns the current system status, service name, uptime (illustrative), and a timestamp." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/status" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"operational\",\n \"serviceName\": \"API Endpoint Explorer Backend\",\n \"version\": \"1.2.3\",\n \"uptimeSeconds\": 18345,\n \"lastChecked\": \"2024-08-15T11:00:00.000Z\"\n}" } ] } ] }, { "name": "Echo API", "description": "Echoes back the data sent to it. Supports GET (query parameters) and POST (JSON or Text body). Useful for request inspection.", "item": [ { "name": "Echoes the query parameters provided in the request URL.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/echo?text=Hello%20World&count=5&active=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "echo" ], "query": [ { "key": "text", "value": "Hello%20World" }, { "key": "count", "value": "5" }, { "key": "active", "value": "true" } ] }, "description": "Echoes the query parameters provided in the request URL." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/echo?text=Hello%20World&count=5&active=true" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"GET\",\n \"queryParams\": {\n \"text\": \"Hello World\",\n \"count\": \"5\",\n \"active\": \"true\"\n },\n \"message\": \"Query parameters echoed successfully.\",\n \"headers\": { \"example-header\": \"example-value\" },\n \"timestamp\": \"2024-08-15T12:00:00.000Z\"\n}" } ] }, { "name": "Echoes the JSON or Text body sent in the request. Try sending non-JSON text too!", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"id\": \"user-789\",\n \"role\": \"admin\"\n },\n \"operation\": \"echo_test\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/echo", "host": [ "{{baseUrl}}" ], "path": [ "api", "echo" ], "query": [] }, "description": "Echoes the JSON or Text body sent in the request. Try sending non-JSON text too!" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/echo" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"POST\",\n \"receivedBody\": {\n \"user\": {\n \"id\": \"user-789\",\n \"role\": \"admin\"\n },\n \"operation\": \"echo_test\"\n },\n \"message\": \"JSON body echoed successfully.\",\n \"headers\": { \"example-header\": \"example-value\" },\n \"timestamp\": \"2024-08-15T12:05:00.000Z\"\n}" } ] } ] }, { "name": "User Management API", "description": "A comprehensive API for managing user accounts, including CRUD operations.", "item": [ { "name": "Retrieves a list of users. Supports an optional `limit` query parameter (e.g., `?limit=5`) to control the number of users returned. If no limit is provided, all users are returned (up to the total of 25 mock users).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "users" ], "query": [] }, "description": "Retrieves a list of users. Supports an optional `limit` query parameter (e.g., `?limit=5`) to control the number of users returned. If no limit is provided, all users are returned (up to the total of 25 mock users)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/users" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"usr_1\",\n \"name\": \"Alice Wonderland\",\n \"email\": \"alice@example.com\",\n \"role\": \"admin\",\n \"createdAt\": \"2024-01-10T10:00:00Z\",\n \"profile\": {\n \"bio\": \"Curiouser and curiouser!\",\n \"avatarUrl\": \"https://placehold.co/100x100.png\"\n }\n },\n {\n \"id\": \"usr_2\",\n \"name\": \"Bob The Builder\",\n \"email\": \"bob@example.com\",\n \"role\": \"editor\",\n \"createdAt\": \"2024-01-11T11:00:00Z\",\n \"profile\": {\n \"bio\": \"Can we fix it?\",\n \"avatarUrl\": \"https://placehold.co/100x100.png\"\n }\n },\n {\n \"id\": \"usr_3\",\n \"name\": \"Charlie Chaplin\",\n \"email\": \"charlie@example.com\",\n \"role\": \"viewer\",\n \"createdAt\": \"2024-01-12T12:00:00Z\",\n \"profile\": {\n \"bio\": \"A day without laughter is a day wasted.\",\n \"avatarUrl\": \"https://placehold.co/100x100.png\"\n }\n },\n {\n \"id\": \"usr_4\",\n \"name\": \"Diana Prince\",\n \"email\": \"diana@example.com\",\n \"role\": \"admin\",\n \"createdAt\": \"2024-01-13T13:00:00Z\",\n \"profile\": {\n \"bio\": \"Wonder Woman\",\n \"avatarUrl\": \"https://placehold.co/100x100.png\"\n }\n },\n {\n \"id\": \"usr_5\",\n \"name\": \"Edward Scissorhands\",\n \"email\": \"edward@example.com\",\n \"role\": \"viewer\",\n \"createdAt\": \"2024-01-14T14:00:00Z\",\n \"profile\": {\n \"bio\": \"I am not complete.\",\n \"avatarUrl\": \"https://placehold.co/100x100.png\"\n }\n }\n]" } ] }, { "name": "Retrieves a specific user by their ID. Replace {userId} with an actual ID like `usr_1`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/{userId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", "{userId}" ], "query": [] }, "description": "Retrieves a specific user by their ID. Replace {userId} with an actual ID like `usr_1`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/users/{userId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"id\": \"usr_1\", \"name\": \"Alice Wonderland\", \"email\": \"alice@example.com\", \"role\": \"admin\", \"createdAt\": \"2024-01-10T10:00:00Z\", \"profile\": {\"bio\": \"Curiouser and curiouser!\", \"avatarUrl\": \"https://placehold.co/100x100.png\" }}" } ] }, { "name": "Creates a new user.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Charlie Brown\",\n \"email\": \"charlie@example.com\",\n \"role\": \"viewer\",\n \"profile\": {\"bio\": \"Good grief!\"}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "users" ], "query": [] }, "description": "Creates a new user." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/users" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"id\": \"usr_new\", \"name\": \"Charlie Brown\", \"email\": \"charlie@example.com\", \"role\": \"viewer\", \"createdAt\": \"2024-08-16T14:30:00Z\", \"profile\": {\"bio\": \"Good grief!\"}}" } ] }, { "name": "Updates an existing user by ID. Replace {userId} with an actual ID like `usr_1`.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice W. Wonderland\",\n \"email\": \"alice.wonderland@example.com\",\n \"role\": \"lead_admin\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/{userId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", "{userId}" ], "query": [] }, "description": "Updates an existing user by ID. Replace {userId} with an actual ID like `usr_1`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/users/{userId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"id\": \"usr_1\", \"name\": \"Alice W. Wonderland\", \"email\": \"alice.wonderland@example.com\", \"role\": \"lead_admin\", \"createdAt\": \"2024-01-10T10:00:00Z\", \"updatedAt\": \"2024-08-16T15:00:00Z\", \"profile\": {\"bio\": \"Curiouser and curiouser!\", \"avatarUrl\": \"https://placehold.co/100x100.png\" }}" } ] }, { "name": "Deletes a user by ID. Replace {userId} with an actual ID like `usr_2`.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/{userId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", "{userId}" ], "query": [] }, "description": "Deletes a user by ID. Replace {userId} with an actual ID like `usr_2`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/users/{userId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\": \"User usr_2 deleted successfully.\", \"timestamp\": \"2024-08-16T15:30:00Z\"}" } ] } ] }, { "name": "Product Catalog API", "description": "API for browsing and managing a product catalog.", "item": [ { "name": "Retrieves a list of products. Supports optional query parameters for filtering (e.g., `?category=electronics&inStock=true`) and `limit` to control the number of products returned (e.g., `?limit=1`).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "products" ], "query": [] }, "description": "Retrieves a list of products. Supports optional query parameters for filtering (e.g., `?category=electronics&inStock=true`) and `limit` to control the number of products returned (e.g., `?limit=1`)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/products" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"prod_123\",\n \"name\": \"The Pragmatic Programmer\",\n \"category\": \"Books\",\n \"price\": 29.99,\n \"stock\": 150,\n \"imageUrl\": \"https://placehold.co/300x200.png\",\n \"description\": \"From journeyman to master.\",\n \"details\": {\n \"pages\": 352,\n \"author\": \"David Thomas, Andrew Hunt\"\n },\n \"reviews\": [\n {\n \"rating\": 5,\n \"comment\": \"A must-read!\"\n }\n ],\n \"createdAt\": \"2024-01-10T10:00:00Z\"\n }\n]" } ] }, { "name": "Retrieves details for a specific product by ID. Replace {productId} with an ID like `prod_123`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "products", "{productId}" ], "query": [] }, "description": "Retrieves details for a specific product by ID. Replace {productId} with an ID like `prod_123`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/products/{productId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"prod_123\",\n \"name\": \"The Pragmatic Programmer\",\n \"category\": \"Books\",\n \"price\": 29.99,\n \"stock\": 150,\n \"imageUrl\": \"https://placehold.co/300x200.png\",\n \"description\": \"From journeyman to master.\",\n \"details\": {\n \"pages\": 352,\n \"author\": \"David Thomas, Andrew Hunt\"\n },\n \"reviews\": [\n {\n \"rating\": 5,\n \"comment\": \"A must-read!\"\n }\n ],\n \"createdAt\": \"2024-01-10T10:00:00Z\"\n}" } ] }, { "name": "Adds a new product to the catalog.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Ergonomic Mechanical Keyboard\",\n \"category\": \"Electronics\",\n \"price\": 159.99,\n \"stock\": 50,\n \"imageUrl\": \"https://placehold.co/300x200.png\",\n \"description\": \"Clicky and comfortable.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/products", "host": [ "{{baseUrl}}" ], "path": [ "api", "products" ], "query": [] }, "description": "Adds a new product to the catalog." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/products" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"prod_new\",\n \"name\": \"Ergonomic Mechanical Keyboard\",\n \"category\": \"Electronics\",\n \"price\": 159.99,\n \"stock\": 50,\n \"imageUrl\": \"https://placehold.co/300x200.png\",\n \"description\": \"Clicky and comfortable.\",\n \"details\": {},\n \"reviews\": [],\n \"createdAt\": \"2024-08-16T16:00:00Z\"\n}" } ] }, { "name": "Updates an existing product by ID. Replace {productId} with an ID like `prod_123`.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"price\": 149.99,\n \"stock\": 45\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "products", "{productId}" ], "query": [] }, "description": "Updates an existing product by ID. Replace {productId} with an ID like `prod_123`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/products/{productId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"prod_123\",\n \"name\": \"Ergonomic Mechanical Keyboard\",\n \"category\": \"Electronics\",\n \"price\": 149.99,\n \"stock\": 45,\n \"imageUrl\": \"https://placehold.co/300x200.png\",\n \"description\": \"Clicky and comfortable.\",\n \"createdAt\": \"2024-01-12T12:00:00Z\",\n \"updatedAt\": \"2024-08-16T16:30:00Z\"\n}" } ] }, { "name": "Deletes a product by ID. Replace {productId} with an ID like `prod_456`.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/products/{productId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "products", "{productId}" ], "query": [] }, "description": "Deletes a product by ID. Replace {productId} with an ID like `prod_456`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/products/{productId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Product prod_456 deleted successfully.\",\n \"timestamp\": \"2024-08-16T17:00:00Z\"\n}" } ] } ] }, { "name": "Authentication API", "description": "Simplified API for user authentication processes like login, logout, and status check.", "item": [ { "name": "Authenticates a user and returns a session token.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"alice@example.com\",\n \"password\": \"securepassword123\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "login" ], "query": [] }, "description": "Authenticates a user and returns a session token." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/auth/login" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Login successful.\",\n \"user\": {\"id\": \"usr_1\", \"name\": \"Alice Wonderland\", \"email\": \"alice@example.com\", \"role\": \"admin\"},\n \"token\": \"mock_jwt_token_string_12345\",\n \"expiresAt\": \"2024-08-17T10:00:00Z\"\n}" } ] }, { "name": "Logs out the current user and invalidates their session.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "logout" ], "query": [] }, "description": "Logs out the current user and invalidates their session." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/auth/logout" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\": \"Logout successful.\", \"timestamp\": \"2024-08-16T17:00:00Z\"}" } ] }, { "name": "Checks the current authentication status of the user.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/auth/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "status" ], "query": [] }, "description": "Checks the current authentication status of the user." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/auth/status" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"isAuthenticated\": true,\n \"user\": {\"id\": \"usr_1\", \"name\": \"Alice Wonderland\", \"email\": \"alice@example.com\", \"role\": \"admin\"},\n \"checkedAt\": \"2024-08-16T17:05:00Z\"\n}" } ] } ] }, { "name": "File Upload & Management API", "description": "Handle file uploads, downloads, metadata, and bulk operations with validation.", "item": [ { "name": "Upload single or multiple files with validation and metadata extraction.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "FormData with \"files\" field containing one or more files (e.g., document.pdf, image.jpg). Max 10MB per file.", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "upload" ], "query": [] }, "description": "Upload single or multiple files with validation and metadata extraction." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/upload" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"files\": [\n {\n \"id\": \"file_abc123\",\n \"originalName\": \"document.pdf\",\n \"filename\": \"file_abc123_document.pdf\",\n \"size\": 1024000,\n \"mimeType\": \"application/pdf\",\n \"uploadedAt\": \"2024-08-16T10:00:00Z\",\n \"url\": \"/api/files/file_abc123\",\n \"downloadUrl\": \"/api/files/file_abc123/download\"\n }\n ],\n \"uploaded\": 1,\n \"message\": \"All 1 file(s) uploaded successfully\"\n}" } ] }, { "name": "List uploaded files with metadata and pagination support.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "files" ], "query": [] }, "description": "List uploaded files with metadata and pagination support." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/files" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"files\": [\n {\n \"id\": \"file_456\",\n \"originalName\": \"profile-photo.jpg\",\n \"size\": 2048000,\n \"mimeType\": \"image/jpeg\",\n \"uploadedAt\": \"2024-08-16T09:30:00Z\",\n \"url\": \"/api/files/file_456\",\n \"description\": \"Profile photo image\",\n \"tags\": [\"image\", \"profile\"]\n }\n ],\n \"pagination\": {\"page\": 1, \"limit\": 10, \"total\": 1, \"pages\": 1, \"hasNext\": false, \"hasPrev\": false},\n \"statistics\": {\"totalFiles\": 1, \"totalSize\": 2048000, \"typeDistribution\": {\"image\": 1}, \"averageSize\": 2048000}\n}" } ] }, { "name": "Get file metadata by ID. Replace {fileId} with an actual ID like `file_123`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/files/{fileId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "files", "{fileId}" ], "query": [] }, "description": "Get file metadata by ID. Replace {fileId} with an actual ID like `file_123`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/files/{fileId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"file_123\",\n \"originalName\": \"sample-document.pdf\",\n \"filename\": \"file_123_sample-document.pdf\",\n \"size\": 1024000,\n \"mimeType\": \"application/pdf\",\n \"uploadedAt\": \"2024-08-16T10:00:00Z\",\n \"url\": \"/api/files/file_123\",\n \"downloadUrl\": \"/api/files/file_123/download\",\n \"description\": \"Sample PDF document for testing\",\n \"tags\": [\"document\", \"sample\"]\n}" } ] }, { "name": "Update file metadata (description, tags). Replace {fileId} with an ID like `file_123`.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated sample PDF document\",\n \"tags\": [\"document\", \"sample\", \"updated\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/files/{fileId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "files", "{fileId}" ], "query": [] }, "description": "Update file metadata (description, tags). Replace {fileId} with an ID like `file_123`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/files/{fileId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"file_123\",\n \"originalName\": \"sample-document.pdf\",\n \"size\": 1024000,\n \"mimeType\": \"application/pdf\",\n \"description\": \"Updated sample PDF document\",\n \"tags\": [\"document\", \"sample\", \"updated\"],\n \"updatedAt\": \"2024-08-17T10:00:00Z\"\n}" } ] }, { "name": "Delete uploaded file by ID. Replace {fileId} with an actual ID like `file_abc`.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/files/{fileId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "files", "{fileId}" ], "query": [] }, "description": "Delete uploaded file by ID. Replace {fileId} with an actual ID like `file_abc`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/files/{fileId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\"message\": \"File file_abc deleted successfully.\", \"timestamp\": \"2024-08-16T11:00:00Z\"}" } ] }, { "name": "Download the actual file content. Replace {fileId} with an ID like `file_123`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/files/{fileId}/download", "host": [ "{{baseUrl}}" ], "path": [ "api", "files", "{fileId}", "download" ], "query": [] }, "description": "Download the actual file content. Replace {fileId} with an ID like `file_123`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/files/{fileId}/download" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "File content of \"sample-document.pdf\" (actual binary data or text based on MIME type will be returned with appropriate headers)." } ] }, { "name": "Perform bulk operations like delete or tag on multiple files.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": \"delete\",\n \"fileIds\": [\"file_123\", \"file_456\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/files/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "files", "bulk" ], "query": [] }, "description": "Perform bulk operations like delete or tag on multiple files." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/files/bulk" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"operation\": \"delete\",\n \"totalFiles\": 2,\n \"successful\": 2,\n \"failed\": 0,\n \"errors\": [],\n \"message\": \"Bulk delete completed: 2 successful, 0 failed\"\n}" } ] }, { "name": "Get information about available bulk operations and their parameters.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/files/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "files", "bulk" ], "query": [] }, "description": "Get information about available bulk operations and their parameters." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/files/bulk" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"endpoint\": \"/api/files/bulk\",\n \"method\": \"POST\",\n \"supportedOperations\": [\n {\"operation\": \"delete\", \"description\": \"Delete multiple files\"},\n {\"operation\": \"tag\", \"description\": \"Add tags to multiple files\"}\n ]\n}" } ] } ] }, { "name": "Advanced Search API", "description": "Demonstrates complex querying, filtering, sorting, and pagination with full-text search capabilities.", "item": [ { "name": "Multi-field search with filters, sorting, and pagination.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "search" ], "query": [] }, "description": "Multi-field search with filters, sorting, and pagination." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/search" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"prod_301\",\n \"title\": \"JavaScript: The Good Parts\",\n \"category\": \"Books\",\n \"price\": 25.99,\n \"relevanceScore\": 0.95\n }\n ],\n \"pagination\": {\"page\": 1, \"limit\": 10, \"total\": 156},\n \"filters\": {\"categories\": [\"Books\", \"Electronics\"], \"priceRange\": {\"min\": 10, \"max\": 500}}\n}" } ] }, { "name": "Complex search with nested filters, aggregations, and custom scoring.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": {\n \"text\": \"programming\",\n \"filters\": {\n \"category\": [\"Books\", \"Courses\"],\n \"price\": {\"min\": 20, \"max\": 100},\n \"rating\": {\"gte\": 4.0}\n }\n },\n \"aggregations\": [\"category\", \"author\", \"price_range\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/search/advanced", "host": [ "{{baseUrl}}" ], "path": [ "api", "search", "advanced" ], "query": [] }, "description": "Complex search with nested filters, aggregations, and custom scoring." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/search/advanced" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"id\": \"prod_301\",\n \"title\": \"JavaScript: The Good Parts\",\n \"category\": \"Books\",\n \"price\": 25.99,\n \"relevanceScore\": 0.95\n },\n {\n \"id\": \"course_101\",\n \"title\": \"Advanced JavaScript Programming\",\n \"category\": \"Courses\",\n \"price\": 89.99,\n \"relevanceScore\": 0.87\n }\n ],\n \"aggregations\": {\n \"category\": {\"Books\": 45, \"Courses\": 23},\n \"price_range\": {\"20-50\": 30, \"50-100\": 38}\n },\n \"totalResults\": 68\n}" } ] }, { "name": "Get search suggestions and autocomplete results.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/search/suggestions", "host": [ "{{baseUrl}}" ], "path": [ "api", "search", "suggestions" ], "query": [] }, "description": "Get search suggestions and autocomplete results." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/search/suggestions" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"suggestions\": [\"programming\", \"programs\", \"progress\", \"progressive\", \"programmer\"],\n \"categories\": [\"Books\", \"Software\", \"Courses\"]\n}" } ] } ] }, { "name": "Notification System API", "description": "Send emails, SMS, and push notifications with template support and delivery tracking.", "item": [ { "name": "Send email notification with template support.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"to\": \"user@example.com\",\n \"template\": \"welcome\",\n \"variables\": {\"name\": \"John\", \"appName\": \"Gen-Endpoint\", \"verificationUrl\": \"https://app.com/verify/123\"},\n \"subject\": \"Welcome to our platform!\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notifications/email", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "email" ], "query": [] }, "description": "Send email notification with template support." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/notifications/email" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"notif_123\",\n \"type\": \"email\",\n \"status\": \"queued\",\n \"scheduledAt\": \"2024-08-16T12:00:00Z\",\n \"estimatedDelivery\": \"2024-08-16T12:01:00Z\"\n}" } ] }, { "name": "Get email notification history.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications/email", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "email" ], "query": [] }, "description": "Get email notification history." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/notifications/email" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notifications\": [\n {\n \"id\": \"notif_123\",\n \"status\": \"delivered\",\n \"recipient\": \"user@example.com\",\n \"subject\": \"Welcome!\",\n \"deliveredAt\": \"2024-08-16T12:01:15Z\"\n }\n ],\n \"pagination\": {\"page\": 1, \"limit\": 10, \"total\": 5}\n}" } ] }, { "name": "Send push notification to devices.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceTokens\": [\"token1\", \"token2\"],\n \"title\": \"New Message\",\n \"body\": \"You have a new message from Alice\",\n \"data\": {\"messageId\": \"msg_456\", \"type\": \"chat\"}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/notifications/push", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "push" ], "query": [] }, "description": "Send push notification to devices." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/notifications/push" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"notif_124\",\n \"type\": \"push\",\n \"status\": \"sent\",\n \"deliveredTo\": 2,\n \"failedDeliveries\": 0\n}" } ] }, { "name": "Get push notification history and stats.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications/push", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "push" ], "query": [] }, "description": "Get push notification history and stats." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/notifications/push" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notifications\": [\n {\n \"id\": \"notif_124\",\n \"title\": \"New Message\",\n \"status\": \"sent\",\n \"deliveredTo\": 2,\n \"createdAt\": \"2024-08-16T12:05:00Z\"\n }\n ],\n \"stats\": {\"totalSent\": 10, \"totalDelivered\": 8, \"successRate\": 80}\n}" } ] }, { "name": "List available notification templates.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/notifications/templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "notifications", "templates" ], "query": [] }, "description": "List available notification templates." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/notifications/templates" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"welcome\",\n \"name\": \"Welcome Email\",\n \"type\": \"email\",\n \"variables\": [\"name\", \"verificationUrl\"]\n },\n {\n \"id\": \"password_reset\",\n \"name\": \"Password Reset\",\n \"type\": \"email\",\n \"variables\": [\"name\", \"resetUrl\"]\n }\n]" } ] } ] }, { "name": "Analytics & Metrics API", "description": "Track events, generate reports, and provide dashboard data with real-time metrics.", "item": [ { "name": "Track user events and custom metrics.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"page_view\",\n \"userId\": \"usr_123\",\n \"sessionId\": \"sess_abc\", \n \"properties\": {\n \"page\": \"/products\",\n \"referrer\": \"google.com\"\n },\n \"timestamp\": \"2024-08-16T12:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/analytics/track", "host": [ "{{baseUrl}}" ], "path": [ "api", "analytics", "track" ], "query": [] }, "description": "Track user events and custom metrics." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/analytics/track" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"eventId\": \"evt_789\",\n \"processed\": true,\n \"timestamp\": \"2024-08-16T12:00:00Z\"\n}" } ] }, { "name": "Get recent tracked events for debugging.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/analytics/track", "host": [ "{{baseUrl}}" ], "path": [ "api", "analytics", "track" ], "query": [] }, "description": "Get recent tracked events for debugging." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/analytics/track" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n {\n \"id\": \"evt_789\",\n \"event\": \"page_view\",\n \"userId\": \"usr_123\",\n \"sessionId\": \"sess_abc\",\n \"timestamp\": \"2024-08-16T12:00:00Z\",\n \"properties\": {\"page\": \"/products\", \"userAgent\": \"Mozilla/5.0...\", \"ip\": \"127.0.0.1\", \"deviceType\": \"desktop\"}\n }\n ],\n \"totalInFilter\": 1,\n \"totalInStore\": 50\n}" } ] }, { "name": "Get dashboard metrics and KPIs for specified time range.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/analytics/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "analytics", "dashboard" ], "query": [] }, "description": "Get dashboard metrics and KPIs for specified time range." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/analytics/dashboard" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"period\": \"7d\",\n \"dateRange\": {\"start\":\"2024-08-09T...\", \"end\":\"2024-08-16T...\"},\n \"metrics\": {\n \"pageviews\": {\"value\": 15420, \"change\": \"+12.5%\"},\n \"uniqueUsers\": {\"value\": 3254, \"change\": \"+8.2%\"},\n \"conversions\": {\"value\": 89, \"change\": \"-2.1%\"}\n },\n \"topPages\": [{\"page\":\"/products\", \"views\":500}, {\"page\":\"/home\", \"views\":300}],\n \"deviceBreakdown\": [{\"device\":\"desktop\", \"count\":10000, \"percentage\":65}, {\"device\":\"mobile\", \"count\":5420, \"percentage\":35}],\n \"realTime\": {\"activeUsers\":123, \"pageViewsLastHour\":1500, \"eventsLastHour\":3200},\n \"generatedAt\":\"2024-08-16T...\" \n}" } ] } ] }, { "name": "Data Export API", "description": "Export data in various formats (CSV, JSON, XML) with filtering and field selection.", "item": [ { "name": "Request data export in CSV, JSON, or XML format. Replace {format} with \"csv\", \"json\", or \"xml\".", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "Path: /api/export/csv\nBody: {\n \"entity\": \"users\",\n \"filters\": {\"role\": \"admin\"},\n \"fields\": [\"name\", \"email\", \"createdAt\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/export/{format}", "host": [ "{{baseUrl}}" ], "path": [ "api", "export", "{format}" ], "query": [] }, "description": "Request data export in CSV, JSON, or XML format. Replace {format} with \"csv\", \"json\", or \"xml\"." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/export/{format}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobId\": \"export_123\",\n \"status\": \"processing\",\n \"format\": \"csv\",\n \"entity\": \"users\",\n \"totalRecords\": 150,\n \"estimatedCompletion\": \"2024-08-16T12:05:00Z\",\n \"statusUrl\": \"/api/export/status/export_123\"\n}" } ] }, { "name": "Get information about the specified export format. Replace {format} with \"csv\", \"json\", or \"xml\".", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/export/{format}", "host": [ "{{baseUrl}}" ], "path": [ "api", "export", "{format}" ], "query": [] }, "description": "Get information about the specified export format. Replace {format} with \"csv\", \"json\", or \"xml\"." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/export/{format}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"format\": \"csv\",\n \"mimeType\": \"text/csv\",\n \"description\": \"Comma-separated values format\",\n \"supportedEntities\": [\"users\", \"products\", \"orders\"], \n \"exampleRequest\": { \"entity\": \"users\", \"filters\": {\"role\": \"admin\"}, \"fields\": [\"name\", \"email\", \"createdAt\"]}\n}" } ] }, { "name": "Check export job status and get download link if completed. Replace {jobId} with an actual job ID like `export_123`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/export/status/{jobId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "export", "status", "{jobId}" ], "query": [] }, "description": "Check export job status and get download link if completed. Replace {jobId} with an actual job ID like `export_123`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/export/status/{jobId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"export_123\",\n \"format\": \"csv\",\n \"entity\": \"users\",\n \"status\": \"completed\",\n \"totalRecords\": 150,\n \"createdAt\": \"2024-08-16T12:00:00Z\",\n \"completedAt\": \"2024-08-16T12:04:30Z\",\n \"downloadUrl\": \"/api/export/download/export_123\",\n \"fileSize\": 2048000,\n \"filename\": \"users-export-2024-08-16.csv\",\n \"mimeType\": \"text/csv\",\n \"progress\": 100\n}" } ] }, { "name": "Cancel an export job. Replace {jobId} with an actual job ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/export/status/{jobId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "export", "status", "{jobId}" ], "query": [] }, "description": "Cancel an export job. Replace {jobId} with an actual job ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/export/status/{jobId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Export job export_456 cancelled successfully\",\n \"jobId\": \"export_456\",\n \"status\": \"cancelled\",\n \"cancelledAt\": \"2024-08-16T12:10:00Z\"\n}" } ] } ] }, { "name": "Shopping Cart API", "description": "Manage shopping cart operations with session handling, item management, and checkout preparation.", "item": [ { "name": "Get cart contents for session. Creates a new cart if sessionId is new or cart expired. Replace {sessionId} with an ID (e.g., sess_123).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}" ], "query": [] }, "description": "Get cart contents for session. Creates a new cart if sessionId is new or cart expired. Replace {sessionId} with an ID (e.g., sess_123)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"sess_123\",\n \"userId\": null,\n \"items\": [\n {\n \"id\": \"item_abc\",\n \"productId\": \"prod_123\",\n \"name\": \"Wireless Headphones\",\n \"priceAtTimeOfAddition\": 99.99,\n \"quantity\": 1,\n \"imageUrl\": \"https://placehold.co/100x100.png\",\n \"options\": {\n \"color\": \"black\"\n },\n \"subtotal\": 99.99\n }\n ],\n \"subtotal\": 99.99,\n \"tax\": 8,\n \"shipping\": 0,\n \"discount\": 0,\n \"total\": 107.99,\n \"createdAt\": \"2024-08-20T10:00:00Z\",\n \"updatedAt\": \"2024-08-20T10:05:00Z\",\n \"expiresAt\": \"2024-08-21T10:00:00Z\"\n}" } ] }, { "name": "Add an item to the cart. Replace {sessionId} with a session ID.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productId\": \"prod_456\",\n \"quantity\": 1,\n \"options\": {\n \"format\": \"paperback\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}", "items" ], "query": [] }, "description": "Add an item to the cart. Replace {sessionId} with a session ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"item\": {\n \"id\": \"item_xyz\",\n \"productId\": \"prod_456\",\n \"name\": \"JavaScript Book\",\n \"priceAtTimeOfAddition\": 29.99,\n \"quantity\": 1,\n \"options\": {\n \"format\": \"paperback\"\n },\n \"imageUrl\": \"https://placehold.co/100x100.png\",\n \"subtotal\": 29.99\n },\n \"cart\": {}\n}" } ] }, { "name": "List all items in the specified cart. Replace {sessionId} with a session ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}", "items" ], "query": [] }, "description": "List all items in the specified cart. Replace {sessionId} with a session ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"item_abc\",\n \"productId\": \"prod_123\",\n \"name\": \"Wireless Headphones\",\n \"priceAtTimeOfAddition\": 99.99,\n \"quantity\": 1,\n \"options\": {\n \"color\": \"black\"\n },\n \"subtotal\": 99.99\n }\n ],\n \"itemCount\": 1,\n \"totals\": {\n \"subtotal\": 99.99,\n \"tax\": 8,\n \"shipping\": 0,\n \"discount\": 0,\n \"total\": 107.99\n }\n}" } ] }, { "name": "Update quantity of an item in the cart. Expects itemId and new quantity. Replace {sessionId} with a session ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"itemId\": \"item_abc\",\n \"quantity\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}", "items" ], "query": [] }, "description": "Update quantity of an item in the cart. Expects itemId and new quantity. Replace {sessionId} with a session ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}" } ] }, { "name": "Remove an item from the cart. Expects itemId. Replace {sessionId} with a session ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}", "items" ], "query": [] }, "description": "Remove an item from the cart. Expects itemId. Replace {sessionId} with a session ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}/items" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}" } ] }, { "name": "Update cart metadata, e.g., apply a coupon code. Replace {sessionId} with a session ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"couponCode\": \"SAVE10\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}" ], "query": [] }, "description": "Update cart metadata, e.g., apply a coupon code. Replace {sessionId} with a session ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}" } ] }, { "name": "Clear all items from the cart (cart session persists but is empty). Replace {sessionId} with a session ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "cart", "{sessionId}" ], "query": [] }, "description": "Clear all items from the cart (cart session persists but is empty). Replace {sessionId} with a session ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/cart/{sessionId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Cart sess_123 cleared successfully.\",\n \"timestamp\": \"2024-08-17T11:05:00Z\"\n}" } ] } ] }, { "name": "Payment Processing API", "description": "Handle payment flows, refunds, and transaction history with multiple payment methods.", "item": [ { "name": "Process payment. Simulates async gateway interaction.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"orderId\": \"order_123\",\n \"amount\": 99.99,\n \"currency\": \"USD\",\n \"paymentMethod\": {\n \"type\": \"card\",\n \"token\": \"tok_visa\"\n },\n \"customerId\": \"cust_abc\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/payments/process", "host": [ "{{baseUrl}}" ], "path": [ "api", "payments", "process" ], "query": [] }, "description": "Process payment. Simulates async gateway interaction." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/payments/process" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paymentId\": \"pay_xyz123\",\n \"status\": \"pending\",\n \"amount\": 99.99,\n \"currency\": \"USD\",\n \"orderId\": \"order_123\",\n \"createdAt\": \"2024-08-20T12:00:00Z\",\n \"message\": \"Payment processing initiated.\"\n}" } ] }, { "name": "Process full or partial refund for a payment. Replace {paymentId} with an actual transaction ID.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 49.99,\n \"reason\": \"customer_request\",\n \"currency\": \"USD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/payments/{paymentId}/refund", "host": [ "{{baseUrl}}" ], "path": [ "api", "payments", "{paymentId}", "refund" ], "query": [] }, "description": "Process full or partial refund for a payment. Replace {paymentId} with an actual transaction ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/payments/{paymentId}/refund" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"refundId\": \"ref_abc789\",\n \"originalPaymentId\": \"pay_xyz123\",\n \"paymentStatus\": \"partially_refunded\",\n \"refundedAmount\": 49.99,\n \"currency\": \"USD\",\n \"reason\": \"customer_request\",\n \"processedAt\": \"2024-08-20T12:05:00Z\",\n \"payment\": {}\n}" } ] }, { "name": "Get payment transaction history. Supports filtering by userId (as customerId), status, orderId, and pagination.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/payments/history", "host": [ "{{baseUrl}}" ], "path": [ "api", "payments", "history" ], "query": [] }, "description": "Get payment transaction history. Supports filtering by userId (as customerId), status, orderId, and pagination." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/payments/history" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payments\": [\n {\n \"id\": \"pay_xyz123\",\n \"orderId\": \"order_123\",\n \"customerId\": \"cust_abc\",\n \"amount\": 99.99,\n \"currency\": \"USD\",\n \"status\": \"succeeded\",\n \"createdAt\": \"2024-08-20T12:00:00Z\",\n \"updatedAt\": \"2024-08-20T12:00:01Z\",\n \"paymentMethod\": {\n \"type\": \"card\",\n \"brand\": \"Visa\",\n \"last4\": \"4242\"\n },\n \"paymentGatewayDetails\": {\n \"gatewayTransactionId\": \"gw_pay_xyz123\",\n \"responseCode\": \"00\",\n \"message\": \"Payment successful\"\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"limit\": 10,\n \"total\": 1,\n \"pages\": 1\n }\n}" } ] } ] }, { "name": "Inventory Management API", "description": "Track stock levels, handle reservations, manage warehouses, and process stock adjustments.", "item": [ { "name": "Get current stock levels and availability. (Note: In a real app, this would be /api/inventory/{productId})", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/inventory/prod_123", "host": [ "{{baseUrl}}" ], "path": [ "api", "inventory", "prod_123" ], "query": [] }, "description": "Get current stock levels and availability. (Note: In a real app, this would be /api/inventory/{productId})" }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/inventory/prod_123" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"productId\": \"prod_123\",\n \"totalStock\": 150,\n \"reserved\": 25,\n \"available\": 125,\n \"warehouses\": [\n {\"id\": \"wh_1\", \"location\": \"NYC\", \"stock\": 75},\n {\"id\": \"wh_2\", \"location\": \"LA\", \"stock\": 75}\n ],\n \"lowStockThreshold\": 20\n}" } ] }, { "name": "Reserve items for orders with automatic expiration.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\"productId\": \"prod_123\", \"quantity\": 2, \"warehouseId\": \"wh_1\"}\n ],\n \"orderId\": \"order_456\",\n \"expiresAt\": \"2024-08-16T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/inventory/reserve", "host": [ "{{baseUrl}}" ], "path": [ "api", "inventory", "reserve" ], "query": [] }, "description": "Reserve items for orders with automatic expiration." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/inventory/reserve" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"reservationId\": \"res_789\",\n \"status\": \"confirmed\",\n \"items\": [\n {\"productId\": \"prod_123\", \"quantity\": 2, \"reserved\": true}\n ],\n \"expiresAt\": \"2024-08-16T13:00:00Z\"\n}" } ] }, { "name": "Adjust stock levels with reason tracking.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productId\": \"prod_123\",\n \"adjustment\": -5,\n \"reason\": \"damaged_goods\",\n \"warehouseId\": \"wh_1\",\n \"notes\": \"Water damage during storage\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/inventory/adjust", "host": [ "{{baseUrl}}" ], "path": [ "api", "inventory", "adjust" ], "query": [] }, "description": "Adjust stock levels with reason tracking." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/inventory/adjust" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"productId\": \"prod_123\",\n \"previousStock\": 150,\n \"newStock\": 145,\n \"adjustmentId\": \"adj_321\"\n}" } ] } ] }, { "name": "Blog & CMS API", "description": "Manage blog posts, categories, tags, content publishing, and SEO metadata.", "item": [ { "name": "List blog posts with pagination, filtering (status, category, search), and sorting.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "posts" ], "query": [] }, "description": "List blog posts with pagination, filtering (status, category, search), and sorting." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/posts" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"posts\": [\n {\n \"id\": \"post_123\",\n \"title\": \"Getting Started with JavaScript\",\n \"slug\": \"getting-started-javascript\",\n \"excerpt\": \"Learn the basics of JavaScript programming...\",\n \"author\": {\"id\": \"usr_1\", \"name\": \"Alice Wonderland\"},\n \"publishedAt\": \"2024-08-15T10:00:00Z\",\n \"readTime\": \"5 min\"\n }\n ],\n \"pagination\": {\"page\": 1, \"limit\": 10, \"total\": 45}\n}" } ] }, { "name": "Create new blog post with SEO metadata.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"Advanced React Patterns\",\n \"content\": \"# Advanced React Patterns - In this post we explore advanced React development patterns including render props, compound components, and custom hooks.\",\n \"excerpt\": \"Explore advanced patterns in React development\",\n \"categoryId\": \"cat_1\",\n \"tags\": [\"react\", \"javascript\", \"frontend\"],\n \"seo\": {\"metaDescription\": \"Learn advanced React patterns\", \"keywords\": [\"react\", \"patterns\"]}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "posts" ], "query": [] }, "description": "Create new blog post with SEO metadata." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/posts" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"post_124\",\n \"title\": \"Advanced React Patterns\",\n \"slug\": \"advanced-react-patterns\",\n \"status\": \"draft\",\n \"createdAt\": \"2024-08-16T12:00:00Z\"\n}" } ] }, { "name": "Get single post by slug with full content. Replace {slug} with an actual post slug like \"getting-started-javascript\".", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/posts/{slug}", "host": [ "{{baseUrl}}" ], "path": [ "api", "posts", "{slug}" ], "query": [] }, "description": "Get single post by slug with full content. Replace {slug} with an actual post slug like \"getting-started-javascript\"." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/posts/{slug}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"post_123\",\n \"title\": \"Getting Started with JavaScript\",\n \"content\": \"# Getting Started with JavaScript - A versatile programming language used for web development.\",\n \"author\": {\"id\": \"usr_1\", \"name\": \"Alice Wonderland\"},\n \"publishedAt\": \"2024-08-15T10:00:00Z\",\n \"views\": 1250,\n \"likes\": 89\n}" } ] }, { "name": "List post categories and tags with post counts.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "categories" ], "query": [] }, "description": "List post categories and tags with post counts." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/categories" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"categories\": [\n {\"id\": \"cat_1\", \"name\": \"Technology\", \"slug\": \"tech\", \"postCount\": 25},\n {\"id\": \"cat_2\", \"name\": \"Design\", \"slug\": \"design\", \"postCount\": 18}\n ],\n \"tags\": [\n {\"name\": \"javascript\", \"count\": 15},\n {\"name\": \"react\", \"count\": 12}\n ]\n}" } ] } ] }, { "name": "Comments & Reviews API", "description": "Handle user comments, reviews, ratings, moderation, and threaded discussions.", "item": [ { "name": "Create new comment or review with rating.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"resourceType\": \"post\",\n \"resourceId\": \"post_123\",\n \"content\": \"Great article! Very helpful.\",\n \"rating\": 5,\n \"parentId\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/comments", "host": [ "{{baseUrl}}" ], "path": [ "api", "comments" ], "query": [] }, "description": "Create new comment or review with rating." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/comments" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"comment_456\",\n \"content\": \"Great article! Very helpful.\",\n \"author\": {\"id\": \"usr_2\", \"name\": \"Bob Builder\"},\n \"rating\": 5,\n \"status\": \"pending_moderation\",\n \"createdAt\": \"2024-08-16T12:00:00Z\"\n}" } ] }, { "name": "Get comments for resource with threading and pagination. Replace {resourceId} with an actual ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/comments/{resourceId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "comments", "{resourceId}" ], "query": [] }, "description": "Get comments for resource with threading and pagination. Replace {resourceId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/comments/{resourceId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"comments\": [\n {\n \"id\": \"comment_456\",\n \"content\": \"Great article!\",\n \"author\": {\"name\": \"Bob Builder\", \"avatar\": \"https://placehold.co/40x40.png\"},\n \"rating\": 5,\n \"replies\": [],\n \"createdAt\": \"2024-08-16T12:00:00Z\"\n }\n ],\n \"summary\": {\"total\": 45, \"averageRating\": 4.2}\n}" } ] }, { "name": "Moderate comment - approve, reject, or flag. Replace {commentId} with an actual ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"approve\",\n \"moderatorNote\": \"Content appropriate\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/comments/{commentId}/moderate", "host": [ "{{baseUrl}}" ], "path": [ "api", "comments", "{commentId}", "moderate" ], "query": [] }, "description": "Moderate comment - approve, reject, or flag. Replace {commentId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/comments/{commentId}/moderate" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"comment_456\",\n \"status\": \"approved\",\n \"moderatedAt\": \"2024-08-16T12:05:00Z\",\n \"moderatedBy\": \"usr_1\"\n}" } ] } ] }, { "name": "Webhook Management API", "description": "Register, manage, test webhook endpoints, and track delivery attempts with retry logic.", "item": [ { "name": "Register new webhook endpoint with event subscriptions.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://api.example.com/webhooks/orders\",\n \"events\": [\"order.created\", \"order.updated\", \"payment.completed\"],\n \"secret\": \"whsec_1234567890\",\n \"description\": \"Order processing webhook\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks" ], "query": [] }, "description": "Register new webhook endpoint with event subscriptions." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/webhooks" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"wh_789\",\n \"url\": \"https://api.example.com/webhooks/orders\",\n \"events\": [\"order.created\", \"order.updated\", \"payment.completed\"],\n \"status\": \"active\",\n \"createdAt\": \"2024-08-16T12:00:00Z\"\n}" } ] }, { "name": "Test webhook delivery with sample payload. Replace {webhookId} with an actual ID.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"order.created\",\n \"testPayload\": {\n \"orderId\": \"order_123\",\n \"amount\": 99.99\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/webhooks/{webhookId}/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks", "{webhookId}", "test" ], "query": [] }, "description": "Test webhook delivery with sample payload. Replace {webhookId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/webhooks/{webhookId}/test" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"testId\": \"test_456\",\n \"status\": \"success\",\n \"responseCode\": 200,\n \"responseTime\": 250,\n \"deliveredAt\": \"2024-08-16T12:01:00Z\"\n}" } ] }, { "name": "Get webhook delivery logs with filtering and status.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/webhooks/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "webhooks", "logs" ], "query": [] }, "description": "Get webhook delivery logs with filtering and status." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/webhooks/logs" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"logs\": [\n {\n \"id\": \"log_123\",\n \"webhookId\": \"wh_789\",\n \"event\": \"order.created\",\n \"status\": \"failed\",\n \"responseCode\": 500,\n \"attempts\": 3,\n \"nextRetry\": \"2024-08-16T12:15:00Z\"\n }\n ]\n}" } ] } ] }, { "name": "Rate Limiting API", "description": "Demonstrate rate limiting patterns, quota management, and different tier restrictions.", "item": [ { "name": "Basic rate limited endpoint (10 requests per minute).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/limited/basic", "host": [ "{{baseUrl}}" ], "path": [ "api", "limited", "basic" ], "query": [] }, "description": "Basic rate limited endpoint (10 requests per minute)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/limited/basic" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Basic tier response\",\n \"data\": {\"timestamp\": \"2024-08-16T12:00:00Z\"},\n \"rateLimit\": {\n \"limit\": 10,\n \"remaining\": 7,\n \"resetAt\": \"2024-08-16T12:01:00Z\"\n }\n}" } ] }, { "name": "Premium rate limited endpoint (100 requests per minute).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/limited/premium", "host": [ "{{baseUrl}}" ], "path": [ "api", "limited", "premium" ], "query": [] }, "description": "Premium rate limited endpoint (100 requests per minute)." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/limited/premium" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Premium tier response\",\n \"data\": {\"enhanced\": true, \"timestamp\": \"2024-08-16T12:00:00Z\"},\n \"rateLimit\": {\n \"limit\": 100,\n \"remaining\": 89,\n \"resetAt\": \"2024-08-16T12:01:00Z\"\n }\n}" } ] }, { "name": "Check current quota usage across all endpoints.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quota/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "quota", "status" ], "query": [] }, "description": "Check current quota usage across all endpoints." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/quota/status" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userId\": \"usr_123\",\n \"plan\": \"premium\",\n \"quotas\": {\n \"api_calls\": {\"used\": 1250, \"limit\": 10000, \"resetDate\": \"2024-09-01\"},\n \"file_uploads\": {\"used\": 45, \"limit\": 100, \"resetDate\": \"2024-09-01\"}\n }\n}" } ] } ] }, { "name": "Real-time Chat API", "description": "WebSocket-based chat with rooms, typing indicators, message history, and user presence.", "item": [ { "name": "List available chat rooms with participant counts.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/chat/rooms", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "rooms" ], "query": [] }, "description": "List available chat rooms with participant counts." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/chat/rooms" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"room_1\",\n \"name\": \"General Discussion\",\n \"description\": \"Main chat room for all users\",\n \"participants\": 45,\n \"lastActivity\": \"2024-08-16T12:00:00Z\",\n \"type\": \"public\"\n },\n {\n \"id\": \"room_2\",\n \"name\": \"Tech Support\",\n \"description\": \"Get help with technical issues\",\n \"participants\": 12,\n \"lastActivity\": \"2024-08-16T11:30:00Z\",\n \"type\": \"public\"\n }\n]" } ] }, { "name": "Create new chat room with customizable settings.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Project Alpha\",\n \"description\": \"Discussion for Project Alpha team\",\n \"type\": \"private\",\n \"maxParticipants\": 20\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/rooms", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "rooms" ], "query": [] }, "description": "Create new chat room with customizable settings." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/chat/rooms" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"room_3\",\n \"name\": \"Project Alpha\",\n \"description\": \"Discussion for Project Alpha team\",\n \"type\": \"private\",\n \"createdAt\": \"2024-08-16T12:00:00Z\",\n \"createdBy\": \"usr_1\"\n}" } ] }, { "name": "Get message history for room with pagination. Replace {roomId} with an actual ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/chat/rooms/{roomId}/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "rooms", "{roomId}", "messages" ], "query": [] }, "description": "Get message history for room with pagination. Replace {roomId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/chat/rooms/{roomId}/messages" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"messages\": [\n {\n \"id\": \"msg_123\",\n \"content\": \"Hello everyone!\",\n \"author\": {\"id\": \"usr_1\", \"name\": \"Alice\", \"avatar\": \"https://placehold.co/40x40.png\"},\n \"timestamp\": \"2024-08-16T11:58:00Z\",\n \"type\": \"text\"\n }\n ],\n \"pagination\": {\"page\": 1, \"limit\": 50, \"hasMore\": true}\n}" } ] }, { "name": "Send message to chat room. Replace {roomId} with an actual ID.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"How is everyone doing?\",\n \"type\": \"text\",\n \"replyTo\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/chat/rooms/{roomId}/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "chat", "rooms", "{roomId}", "messages" ], "query": [] }, "description": "Send message to chat room. Replace {roomId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/chat/rooms/{roomId}/messages" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"msg_124\",\n \"content\": \"How is everyone doing?\",\n \"author\": {\"id\": \"usr_2\", \"name\": \"Bob\"},\n \"timestamp\": \"2024-08-16T12:00:00Z\",\n \"roomId\": \"room_1\"\n}" } ] } ] }, { "name": "Background Jobs API", "description": "Queue and monitor long-running background tasks with progress tracking and retry logic.", "item": [ { "name": "Queue new background job with parameters.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"data_export\",\n \"parameters\": {\n \"format\": \"csv\",\n \"entity\": \"users\",\n \"filters\": {\"role\": \"admin\"}\n },\n \"priority\": \"normal\",\n \"scheduledAt\": \"2024-08-16T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/jobs", "host": [ "{{baseUrl}}" ], "path": [ "api", "jobs" ], "query": [] }, "description": "Queue new background job with parameters." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/jobs" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"job_789\",\n \"type\": \"data_export\",\n \"status\": \"queued\",\n \"priority\": \"normal\",\n \"queuePosition\": 3,\n \"estimatedStartTime\": \"2024-08-16T12:05:00Z\"\n}" } ] }, { "name": "Get job status, progress, and results. Replace {jobId} with an actual ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/jobs/{jobId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "jobs", "{jobId}" ], "query": [] }, "description": "Get job status, progress, and results. Replace {jobId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/jobs/{jobId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"job_789\",\n \"type\": \"data_export\",\n \"status\": \"completed\",\n \"progress\": 100,\n \"startedAt\": \"2024-08-16T12:03:00Z\",\n \"completedAt\": \"2024-08-16T12:08:00Z\",\n \"result\": {\n \"downloadUrl\": \"/api/downloads/export_789.csv\",\n \"recordsProcessed\": 1500\n }\n}" } ] }, { "name": "List jobs with status filtering and pagination.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/jobs", "host": [ "{{baseUrl}}" ], "path": [ "api", "jobs" ], "query": [] }, "description": "List jobs with status filtering and pagination." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/jobs" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jobs\": [\n {\n \"id\": \"job_790\",\n \"type\": \"data_export\",\n \"status\": \"running\",\n \"progress\": 45,\n \"startedAt\": \"2024-08-16T12:10:00Z\"\n }\n ],\n \"pagination\": {\"page\": 1, \"limit\": 20, \"total\": 156}\n}" } ] }, { "name": "Cancel queued or running job. Replace {jobId} with an actual ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/jobs/{jobId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "jobs", "{jobId}" ], "query": [] }, "description": "Cancel queued or running job. Replace {jobId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/jobs/{jobId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"job_791\",\n \"status\": \"cancelled\",\n \"cancelledAt\": \"2024-08-16T12:15:00Z\",\n \"reason\": \"user_requested\"\n}" } ] } ] }, { "name": "URL Shortener API", "description": "Create, manage, and get stats for shortened URLs. Includes a redirector endpoint.", "item": [ { "name": "Create a new shortened URL. Custom alias (shortCode) and expiration are optional.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"originalUrl\": \"https://www.verylongurl.com/path/to/something/interesting?query=param\",\n \"customAlias\": \"my-custom-link\",\n \"description\": \"Link to an interesting article\",\n \"expiresAt\": \"2025-12-31T23:59:59Z\",\n \"userId\": \"user_abc_123\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/shorten", "host": [ "{{baseUrl}}" ], "path": [ "api", "shorten" ], "query": [] }, "description": "Create a new shortened URL. Custom alias (shortCode) and expiration are optional." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/shorten" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"link_nanoid10\",\n \"shortUrl\": \"http://localhost:3000/s/my-custom-link\",\n \"originalUrl\": \"https://www.verylongurl.com/path/to/something/interesting?query=param\",\n \"shortCode\": \"my-custom-link\",\n \"createdAt\": \"2024-08-20T10:00:00.000Z\",\n \"expiresAt\": \"2025-12-31T23:59:59Z\",\n \"description\": \"Link to an interesting article\",\n \"clickCount\": 0\n}" } ] }, { "name": "Get statistics for a shortened URL. Replace {shortCode} with an actual short code.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/stats/{shortCode}", "host": [ "{{baseUrl}}" ], "path": [ "api", "stats", "{shortCode}" ], "query": [] }, "description": "Get statistics for a shortened URL. Replace {shortCode} with an actual short code." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/stats/{shortCode}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"shortCode\": \"my-custom-link\",\n \"originalUrl\": \"https://www.verylongurl.com/path/to/something/interesting?query=param\",\n \"totalClicks\": 150,\n \"uniqueClicks\": 150,\n \"clicksByDate\": [],\n \"topReferrers\": [],\n \"countries\": [],\n \"createdAt\": \"2024-08-20T10:00:00.000Z\",\n \"description\": \"Link to an interesting article\",\n \"expiresAt\": \"2025-12-31T23:59:59Z\"\n}" } ] }, { "name": "List all shortened URLs. Supports optional `userId` query parameter for filtering.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/links", "host": [ "{{baseUrl}}" ], "path": [ "api", "links" ], "query": [] }, "description": "List all shortened URLs. Supports optional `userId` query parameter for filtering." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/links" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"links\": [\n {\n \"id\": \"link_nanoid10\",\n \"shortCode\": \"my-custom-link\",\n \"originalUrl\": \"https://www.verylongurl.com/path/to/something/interesting?query=param\",\n \"totalClicks\": 150,\n \"status\": \"active\",\n \"createdAt\": \"2024-08-20T10:00:00.000Z\",\n \"description\": \"Link to an interesting article\",\n \"expiresAt\": \"2025-12-31T23:59:59Z\",\n \"userId\": \"user_abc_123\"\n },\n {\n \"id\": \"link_anotherid\",\n \"shortCode\": \"another\",\n \"originalUrl\": \"https://www.anotherurl.com\",\n \"totalClicks\": 75,\n \"status\": \"expired\",\n \"createdAt\": \"2023-01-15T10:00:00.000Z\",\n \"description\": \"Old link\",\n \"expiresAt\": \"2023-12-31T23:59:59Z\",\n \"userId\": \"user_def_456\"\n }\n ]\n}" } ] }, { "name": "Get details for a specific short link by its internal ID. Replace {linkId} with an actual link ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/links/{linkId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "links", "{linkId}" ], "query": [] }, "description": "Get details for a specific short link by its internal ID. Replace {linkId} with an actual link ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/links/{linkId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"link_nanoid10\",\n \"shortCode\": \"my-custom-link\",\n \"originalUrl\": \"https://www.verylongurl.com/path/to/something/interesting?query=param\",\n \"totalClicks\": 150,\n \"status\": \"active\",\n \"createdAt\": \"2024-08-20T10:00:00.000Z\",\n \"description\": \"Link to an interesting article\",\n \"expiresAt\": \"2025-12-31T23:59:59Z\",\n \"userId\": \"user_abc_123\"\n}" } ] }, { "name": "Delete a specific short link by its internal ID. Replace {linkId} with an actual link ID.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/links/{linkId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "links", "{linkId}" ], "query": [] }, "description": "Delete a specific short link by its internal ID. Replace {linkId} with an actual link ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "DELETE", "url": { "raw": "{{baseUrl}}/api/links/{linkId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Link link_nanoid10 deleted successfully\",\n \"deletedAt\": \"2024-08-20T12:30:00.000Z\"\n}" } ] }, { "name": "Redirector endpoint. Accessing this path with a valid shortCode redirects to the original URL and increments the click count. This is not a JSON API but the core functionality.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/s/{shortCode}", "host": [ "{{baseUrl}}" ], "path": [ "s", "{shortCode}" ], "query": [] }, "description": "Redirector endpoint. Accessing this path with a valid shortCode redirects to the original URL and increments the click count. This is not a JSON API but the core functionality." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/s/{shortCode}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "(HTTP 302 Redirect to originalUrl)" } ] } ] }, { "name": "QR Code Generator API", "description": "Generate QR codes for text, URLs, and structured data with customizable styling.", "item": [ { "name": "Generate QR code image with customizable options.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": \"https://www.example.com\",\n \"size\": 256,\n \"format\": \"png\",\n \"errorCorrection\": \"M\",\n \"foregroundColor\": \"#000000\",\n \"backgroundColor\": \"#FFFFFF\",\n \"margin\": 4\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/qr/generate", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "generate" ], "query": [] }, "description": "Generate QR code image with customizable options." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/qr/generate" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"qr_456\",\n \"imageUrl\": \"/api/qr/qr_456/image.png\",\n \"data\": \"https://www.example.com\",\n \"size\": 256,\n \"format\": \"png\",\n \"createdAt\": \"2024-08-16T12:00:00Z\",\n \"downloadUrls\": {\n \"png\": \"/api/qr/qr_456/download.png\",\n \"svg\": \"/api/qr/qr_456/download.svg\",\n \"pdf\": \"/api/qr/qr_456/download.pdf\"\n }\n}" } ] }, { "name": "Get QR code metadata and download links. Replace {qrId} with an actual ID like `qr_456`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/qr/{qrId}", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "{qrId}" ], "query": [] }, "description": "Get QR code metadata and download links. Replace {qrId} with an actual ID like `qr_456`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/qr/{qrId}" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"qr_456\",\n \"data\": \"https://www.example.com\",\n \"imageUrl\": \"/api/qr/qr_456/image.png\",\n \"downloadUrls\": {\n \"png\": \"/api/qr/qr_456/download.png\",\n \"svg\": \"/api/qr/qr_456/download.svg\",\n \"pdf\": \"/api/qr/qr_456/download.pdf\"\n },\n \"scanCount\": 45,\n \"createdAt\": \"2024-08-16T12:00:00Z\"\n}" } ] }, { "name": "Retrieve the QR code as a PNG image. Replace {qrId} with an actual ID like `qr_456`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/image.png", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "{qrId}", "image.png" ], "query": [] }, "description": "Retrieve the QR code as a PNG image. Replace {qrId} with an actual ID like `qr_456`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/image.png" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "(Binary PNG image data)" } ] }, { "name": "Download the QR code as a PNG file. Replace {qrId} with an actual ID like `qr_456`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/download.png", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "{qrId}", "download.png" ], "query": [] }, "description": "Download the QR code as a PNG file. Replace {qrId} with an actual ID like `qr_456`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/download.png" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "(File download of PNG image)" } ] }, { "name": "Download the QR code as an SVG file. Replace {qrId} with an actual ID like `qr_456`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/download.svg", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "{qrId}", "download.svg" ], "query": [] }, "description": "Download the QR code as an SVG file. Replace {qrId} with an actual ID like `qr_456`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/download.svg" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "(File download of SVG image)" } ] }, { "name": "Download the QR code as a PDF file. Replace {qrId} with an actual ID like `qr_456`.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/download.pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "{qrId}", "download.pdf" ], "query": [] }, "description": "Download the QR code as a PDF file. Replace {qrId} with an actual ID like `qr_456`." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/qr/{qrId}/download.pdf" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "(File download of PDF document)" } ] }, { "name": "Generate multiple QR codes in batch.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"codes\": [\n {\"data\": \"https://example.com/page1\", \"filename\": \"page1\"},\n {\"data\": \"https://example.com/page2\", \"filename\": \"page2\"}\n ],\n \"format\": \"png\",\n \"size\": 256\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/qr/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "qr", "batch" ], "query": [] }, "description": "Generate multiple QR codes in batch." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/qr/batch" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"batchId\": \"batch_789\",\n \"status\": \"processing\",\n \"totalCodes\": 2,\n \"estimatedCompletion\": \"2024-08-16T12:02:00Z\"\n}" } ] } ] }, { "name": "Device Management API", "description": "Register and manage mobile devices, push tokens, preferences, and device analytics.", "item": [ { "name": "Register new device with platform and capabilities.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"device_abc123\",\n \"platform\": \"ios\",\n \"osVersion\": \"17.0\",\n \"appVersion\": \"1.2.3\",\n \"pushToken\": \"apns_token_123\",\n \"deviceInfo\": {\n \"model\": \"iPhone 15 Pro\",\n \"manufacturer\": \"Apple\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/devices/register", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices", "register" ], "query": [] }, "description": "Register new device with platform and capabilities." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "POST", "url": { "raw": "{{baseUrl}}/api/devices/register" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"dev_789\",\n \"deviceId\": \"device_abc123\",\n \"platform\": \"ios\",\n \"status\": \"active\",\n \"registeredAt\": \"2024-08-16T12:00:00Z\",\n \"lastSeen\": \"2024-08-16T12:00:00Z\"\n}" } ] }, { "name": "Update push notification token for device. Replace {deviceId} with an actual ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pushToken\": \"new_apns_token_456\",\n \"tokenType\": \"apns\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/devices/{deviceId}/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices", "{deviceId}", "token" ], "query": [] }, "description": "Update push notification token for device. Replace {deviceId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/devices/{deviceId}/token" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deviceId\": \"device_abc123\",\n \"pushToken\": \"new_apns_token_456\",\n \"updatedAt\": \"2024-08-16T12:05:00Z\",\n \"status\": \"token_updated\"\n}" } ] }, { "name": "List user devices with last activity and status.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/devices", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices" ], "query": [] }, "description": "List user devices with last activity and status." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/devices" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"dev_789\",\n \"deviceId\": \"device_abc123\",\n \"platform\": \"ios\",\n \"deviceInfo\": {\"model\": \"iPhone 15 Pro\"},\n \"lastSeen\": \"2024-08-16T12:00:00Z\",\n \"status\": \"active\"\n },\n {\n \"id\": \"dev_790\",\n \"deviceId\": \"device_def456\",\n \"platform\": \"android\",\n \"deviceInfo\": {\"model\": \"Pixel 8\"},\n \"lastSeen\": \"2024-08-15T18:30:00Z\",\n \"status\": \"inactive\"\n }\n]" } ] }, { "name": "Update notification preferences for device. Replace {deviceId} with an actual ID.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"notifications\": {\n \"push\": true,\n \"email\": false,\n \"marketing\": false\n },\n \"quietHours\": {\n \"enabled\": true,\n \"start\": \"22:00\",\n \"end\": \"08:00\",\n \"timezone\": \"America/New_York\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/devices/{deviceId}/preferences", "host": [ "{{baseUrl}}" ], "path": [ "api", "devices", "{deviceId}", "preferences" ], "query": [] }, "description": "Update notification preferences for device. Replace {deviceId} with an actual ID." }, "response": [ { "name": "Success Response", "originalRequest": { "method": "PUT", "url": { "raw": "{{baseUrl}}/api/devices/{deviceId}/preferences" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deviceId\": \"device_abc123\",\n \"preferences\": {\n \"notifications\": {\n \"push\": true,\n \"email\": false,\n \"marketing\": false\n },\n \"quietHours\": {\n \"enabled\": true,\n \"start\": \"22:00\",\n \"end\": \"08:00\",\n \"timezone\": \"America/New_York\"\n }\n },\n \"updatedAt\": \"2024-08-16T12:10:00Z\"\n}" } ] } ] } ] }