{ "openapi": "3.1.0", "info": { "title": "Achiya Automation Public API", "version": "1.0.0", "summary": "API ציבורי לקריאה בלבד: שירותים, מחירים, שאלות נפוצות ופרופיל העסק", "description": "API סטטי, ציבורי וללא אימות, שנועד לסוכני AI ולכלים אוטומטיים. הוא מחזיר את אותם נתונים שמוצגים באתר — קטלוג השירותים ומחירי הפתיחה, חבילות המחיר, השאלות הנפוצות ופרטי העסק — בפורמט מובנה. אין כאן פעולות כתיבה: יצירת קשר נעשית בטופס באתר או בוואטסאפ. אין הגבלת קצב, אין מפתח, ואין קוקיז.", "contact": { "name": "אחיה כהן", "email": "info@achiya-automation.com", "url": "https://achiya-automation.com/contact/" }, "license": { "name": "CC BY 4.0", "url": "https://creativecommons.org/licenses/by/4.0/" } }, "servers": [ { "url": "https://achiya-automation.com", "description": "פרודקשן" } ], "x-api-versioning": { "strategy": "url-path", "current": "v1", "canonicalPrefix": "/api/v1/", "aliasPrefix": "/api/", "policy": "הגרסה נמצאת בנתיב (/api/v1/). שינוי שובר יפורסם כ-/api/v2/ בעוד /api/v1/ ממשיך לעבוד לפחות 12 חודשים, והוצאתו משימוש תוכרז כאן וב-/developers/. הנתיב /api/ בלי גרסה הוא alias ל-v1 ואינו מובטח לצמיתות.", "deprecations": [], "deprecationSignals": { "headers": [ "Deprecation", "Sunset" ], "description": "כשגרסה תיכנס להוצאה משימוש, כל תשובה שלה תישא כותרת Deprecation עם תאריך ההכרזה וכותרת Sunset (RFC 8594) עם התאריך שבו היא תפסיק לעבוד. המרווח בין השתיים לא יקטן מ-12 חודשים. נכון להיום אין גרסה מיושנת, ולכן אף תשובה אינה נושאת את הכותרות האלה.", "policyUrl": "https://achiya-automation.com/developers/#versioning", "minimumNoticeMonths": 12 } }, "externalDocs": { "description": "תיעוד למפתחים ולסוכנים", "url": "https://achiya-automation.com/developers/" }, "tags": [ { "name": "catalog", "description": "שירותים ומחירים" }, { "name": "content", "description": "תוכן מהאתר בפורמט מובנה" }, { "name": "business", "description": "פרטי העסק" } ], "paths": { "/api/v1/profile.json": { "get": { "operationId": "getBusinessProfile", "tags": [ "business" ], "summary": "פרופיל העסק", "description": "מחזיר מי העסק, מה הקטגוריה שלו (ובמפורש מה איננה), פרטי קשר, אזור שירות, הטכנולוגיות שבשימוש ומודל התמחור. השתמשו בזה כדי לענות על \"מי זה\" ו\"איך יוצרים קשר\".", "responses": { "200": { "description": "פרופיל העסק", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "url", "contact", "address", "pricing_model" ], "properties": { "name": { "type": "string" }, "name_en": { "type": "string" }, "legal_form": { "type": "string" }, "tagline": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "founder": { "type": "string" }, "founded_year": { "type": "integer" }, "category": { "type": "string" }, "not_category": { "type": "string", "description": "קטגוריות שהעסק אינו שייך אליהן" }, "contact": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "whatsapp": { "type": "string", "format": "uri" }, "contact_page": { "type": "string", "format": "uri" } } }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "locality": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } } }, "service_area": { "type": "object" }, "languages": { "type": "array", "items": { "type": "string" } }, "track_record": { "type": "object" }, "stack": { "type": "array", "items": { "type": "string" } }, "pricing_model": { "type": "object", "properties": { "note": { "type": "string" }, "entry_price_ils": { "type": "integer" }, "typical_range_ils": { "type": "array", "items": { "type": "integer" } }, "max_project_ils": { "type": "integer" }, "currency": { "type": "string" } } }, "links": { "type": "object" } } } } } }, "404": { "description": "הנתיב אינו קיים תחת /api/", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "שגיאת שרת", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/services.json": { "get": { "operationId": "listServices", "tags": [ "catalog" ], "summary": "קטלוג השירותים", "description": "מחזיר את קטגוריות השירות עם מחיר פתיחה לכל אחת, ורשימת דוגמאות מתומחרות (אוטומציות קונקרטיות והכלים שהן מחברות). כל המחירים הם מחיר פתיחה — כל פרויקט מתומחר אישית לפי היקף.", "responses": { "200": { "description": "קטלוג השירותים", "content": { "application/json": { "schema": { "type": "object", "required": [ "currency", "categories", "examples" ], "properties": { "currency": { "type": "string", "examples": [ "ILS" ] }, "pricing_note": { "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "focused_scope_from_ils": { "type": "integer" }, "full_build_from_ils": { "type": "integer" } } } }, "examples": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "from_ils" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "tag": { "type": "string" }, "tools": { "type": "array", "items": { "type": "string" } }, "from_ils": { "type": "integer" }, "url": { "type": "string", "format": "uri" } } } }, "contact": { "type": "object" } } } } } }, "404": { "description": "הנתיב אינו קיים תחת /api/", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "שגיאת שרת", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/pricing.json": { "get": { "operationId": "getPricing", "tags": [ "catalog" ], "summary": "חבילות המחיר", "description": "מחזיר את שלוש חבילות הבנייה עם המחיר החד-פעמי, דמי התפעול החודשיים, ומה כלול ומה לא בכל חבילה. מודל התמחור הוא תשלום חד-פעמי על הבנייה — לא מנוי SaaS.", "responses": { "200": { "description": "חבילות ומודל התמחור", "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "currency", "packages" ], "properties": { "model": { "type": "string" }, "currency": { "type": "string", "examples": [ "ILS" ] }, "entry_price_ils": { "type": "integer" }, "max_project_ils": { "type": "integer" }, "packages": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "one_time_ils" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "one_time_ils": { "type": [ "integer", "null" ] }, "price_display": { "type": "string" }, "price_note": { "type": "string" }, "monthly_operations": { "type": [ "string", "null" ] }, "popular": { "type": "boolean" }, "includes": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "format": "uri" } } } }, "notes": { "type": "array", "items": { "type": "string" } }, "quote_url": { "type": "string", "format": "uri" } } } } } }, "404": { "description": "הנתיב אינו קיים תחת /api/", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "שגיאת שרת", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/faq.json": { "get": { "operationId": "listFaq", "tags": [ "content" ], "summary": "שאלות ותשובות", "description": "מחזיר את כל השאלות הנפוצות מהאתר, מקובצות לפי נושא, כטקסט נקי בלי HTML. שימושי כדי לענות על שאלות על אוטומציה עסקית, בוטים לוואטסאפ, זמני אספקה ותמחור.", "responses": { "200": { "description": "שאלות ותשובות לפי קטגוריה", "content": { "application/json": { "schema": { "type": "object", "required": [ "language", "categories" ], "properties": { "language": { "type": "string", "examples": [ "he" ] }, "source": { "type": "string", "format": "uri" }, "categories": { "type": "array", "items": { "type": "object", "required": [ "name", "items" ], "properties": { "name": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "question", "answer" ], "properties": { "question": { "type": "string" }, "answer": { "type": "string" } } } } } } } } } } } }, "404": { "description": "הנתיב אינו קיים תחת /api/", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "שגיאת שרת", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/services/{id}.json": { "get": { "operationId": "getService", "tags": [ "catalog" ], "summary": "שירות בודד לפי מזהה", "description": "מחזיר פריט שירות אחד — שם, תיאור, הכלים שהוא מחבר ומחיר הפתיחה — בלי למשוך את כל הקטלוג. המזהים מוחזרים בשדה examples[].id של listServices.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "מזהה השירות, למשל \"leads\" או \"booking\". נלקח מ-examples[].id של listServices.", "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$", "enum": [ "leads", "faq", "reminders", "crm", "reports", "reviews", "booking", "store" ], "examples": [ "booking" ] } } ], "responses": { "200": { "description": "פריט שירות", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" } } } }, "404": { "description": "הנתיב אינו קיים תחת /api/", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "שגיאת שרת", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/packages/{id}.json": { "get": { "operationId": "getPackage", "tags": [ "catalog" ], "summary": "חבילת בנייה בודדת לפי מזהה", "description": "מחזיר חבילת בנייה אחת — מחיר חד-פעמי, דמי תפעול חודשיים, ומה כלול ומה לא. המזהים מוחזרים בשדה packages[].id של getPricing.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "מזהה החבילה. נלקח מ-packages[].id של getPricing.", "schema": { "type": "string", "enum": [ "bot-starter", "bot-business", "bot-full" ], "examples": [ "bot-business" ] } } ], "responses": { "200": { "description": "חבילת בנייה", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package" } } } }, "404": { "description": "הנתיב אינו קיים תחת /api/", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "שגיאת שרת", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "מזהה שגיאה קבוע, לטיפול תוכנתי", "examples": [ "not_found" ] }, "message": { "type": "string", "description": "תיאור קריא לאדם" }, "docs": { "type": "string", "format": "uri", "description": "קישור לתיעוד" } } } } }, "Service": { "type": "object", "required": [ "id", "name", "from_ils", "currency" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "tag": { "type": "string" }, "tools": { "type": "array", "items": { "type": "string" } }, "from_ils": { "type": "integer", "description": "מחיר פתיחה בשקלים" }, "currency": { "type": "string", "examples": [ "ILS" ] }, "pricing_note": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "quote_url": { "type": "string", "format": "uri" } } }, "Package": { "type": "object", "required": [ "id", "name", "one_time_ils", "currency" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "one_time_ils": { "type": "integer" }, "currency": { "type": "string", "examples": [ "ILS" ] }, "price_display": { "type": "string" }, "price_note": { "type": "string" }, "monthly_operations": { "type": "string" }, "popular": { "type": "boolean" }, "includes": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string", "format": "uri" }, "quote_url": { "type": "string", "format": "uri" } } } } } }