{"openapi":"3.1.0","info":{"title":"FASS API","version":"1.0.0","description":"Prices, website quotes and enquiries from FASS (Fadiya Software Solutions Ltd), for integrations such as Zapier and Make. Prices are in Nigerian naira. Nothing moves money: a saved quote is a link the person opens and pays themselves. Keys are issued by FASS, each limited to the endpoints it needs.","contact":{"name":"FASS","url":"https://www.fass.ng/contact"}},"servers":[{"url":"https://www.fass.ng"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"A FASS API key, sent as Authorization: Bearer <key>."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}},"paths":{"/api/v1/prices":{"get":{"operationId":"get_prices","summary":"Read prices","description":"The published price list in naira: packages, small orders, maintenance plans, add-ons, domains, hosting and payment terms. Needs a key with the \"get_prices\" scope.","responses":{"200":{"description":"The result.","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key, or the key was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is not allowed to use this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/policies":{"get":{"operationId":"get_policies","summary":"Read payment and refund terms","description":"The payment and refund terms in full, with links to the terms of service and privacy policy. Needs a key with the \"get_policies\" scope.","responses":{"200":{"description":"The result.","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key, or the key was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is not allowed to use this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/website-price":{"post":{"operationId":"price_website","summary":"Price a website","description":"The first-year price of a website from a few answers, with each line, the deposit, the balance and the cost from year two. Nothing is saved. Needs a key with the \"price_website\" scope.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"businessType":{"type":"string","enum":["shop","restaurant","salon","clinic","professional","school","church","property","other"],"description":"The kind of business: shop (Shop or online seller), restaurant (Restaurant, bakery or caterer), salon (Salon, spa or fashion), clinic (Clinic, pharmacy or health), professional (Lawyer, consultant or agency), school (School), church (Church, mosque or NGO), property (Landlord, estate or realtor), other (Something else)."},"goal":{"type":"string","enum":["presence","enquiries","sell"],"description":"presence: a simple website (Launch). enquiries: show products, work or news and win enquiries (Business). sell: take orders and payments online (Commerce)."},"contentReady":{"type":"boolean","description":"Whether the business already has the words for its website. If false, we write them as part of the build, at no extra cost. Default true."},"domain":{"type":"string","description":"The domain ending wanted, such as .com.ng, .ng or .sch.ng, or \"have\" if they already own a domain. Default .com.ng."},"wantsManagedHosting":{"type":"boolean","description":"Whether FASS should host the website. Default true."},"emailAddresses":{"type":"integer","minimum":0,"maximum":50,"description":"Email inboxes wanted on their own domain. Default 0."},"emailPlan":{"type":"string","description":"An email plan id from the add-ons in get_prices (email-starter, email-business, email-team, email-premium). Default: the cheapest plan that covers the inboxes and domains."},"emailDomains":{"type":"integer","minimum":1,"maximum":3,"description":"How many domains the email is for. Email setup is charged per domain. Default 1."},"carePlan":{"type":"string","enum":["none","updates","growth"],"description":"An optional monthly plan of changes, only for websites we host (wantsManagedHosting true): our hosting already includes upkeep. Updates and growth have a 3-month minimum. Default none."}},"required":["businessType","goal"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"The request could not be done; the message says why.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"No API key, or the key was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is not allowed to use this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/quotes":{"post":{"operationId":"save_quote","summary":"Save website quotes","description":"Saves the same answers as a quote and returns its link, held for 14 days. The person opens it and pays the deposit themselves. Needs a key with the \"save_quote\" scope.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"businessType":{"type":"string","enum":["shop","restaurant","salon","clinic","professional","school","church","property","other"],"description":"The kind of business: shop (Shop or online seller), restaurant (Restaurant, bakery or caterer), salon (Salon, spa or fashion), clinic (Clinic, pharmacy or health), professional (Lawyer, consultant or agency), school (School), church (Church, mosque or NGO), property (Landlord, estate or realtor), other (Something else)."},"goal":{"type":"string","enum":["presence","enquiries","sell"],"description":"presence: a simple website (Launch). enquiries: show products, work or news and win enquiries (Business). sell: take orders and payments online (Commerce)."},"contentReady":{"type":"boolean","description":"Whether the business already has the words for its website. If false, we write them as part of the build, at no extra cost. Default true."},"domain":{"type":"string","description":"The domain ending wanted, such as .com.ng, .ng or .sch.ng, or \"have\" if they already own a domain. Default .com.ng."},"wantsManagedHosting":{"type":"boolean","description":"Whether FASS should host the website. Default true."},"emailAddresses":{"type":"integer","minimum":0,"maximum":50,"description":"Email inboxes wanted on their own domain. Default 0."},"emailPlan":{"type":"string","description":"An email plan id from the add-ons in get_prices (email-starter, email-business, email-team, email-premium). Default: the cheapest plan that covers the inboxes and domains."},"emailDomains":{"type":"integer","minimum":1,"maximum":3,"description":"How many domains the email is for. Email setup is charged per domain. Default 1."},"carePlan":{"type":"string","enum":["none","updates","growth"],"description":"An optional monthly plan of changes, only for websites we host (wantsManagedHosting true): our hosting already includes upkeep. Updates and growth have a 3-month minimum. Default none."}},"required":["businessType","goal"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"The request could not be done; the message says why.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"No API key, or the key was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is not allowed to use this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/enquiries":{"post":{"operationId":"send_enquiry","summary":"Send enquiries","description":"Sends an enquiry to the FASS team, as the contact form does. Needs a key with the \"send_enquiry\" scope.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":100,"description":"The person's name."},"email":{"type":"string","description":"Their email address. Give an email, a phone number, or both."},"phone":{"type":"string","description":"Their WhatsApp or phone number."},"company":{"type":"string","maxLength":100,"description":"Their business or organisation."},"service":{"type":"string","minLength":1,"maxLength":100,"description":"What they need, for example \"Business website\" or \"School management system\"."},"message":{"type":"string","maxLength":5000,"description":"What they want, in their words."},"packageId":{"type":"string","description":"A package id from get_prices, if they chose one."}},"required":["name","service"],"additionalProperties":false}}}},"responses":{"200":{"description":"The result.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"The request could not be done; the message says why.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"No API key, or the key was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key is not allowed to use this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}