diff --git a/src/pages/faq.md b/src/pages/faq.md index 910835a..0bcfeae 100644 --- a/src/pages/faq.md +++ b/src/pages/faq.md @@ -8,61 +8,55 @@ hide_table_of_contents: true - [🔑 How do i get an API Key?](#-how-do-i-get-an-api-key) - [👨‍💻 I am going to use this API for my company/client project, which email should i use in form?](#-i-am-going-to-use-this-api-for-my-companyclient-project-which-email-should-i-use-in-form) - - [🧐 "Hey, you're taking my personal informations on form", why should i give you?](#-hey-youre-taking-my-personal-informations-on-form-why-should-i-give-you) - - [🕐 How much time it will take to recieve API Key?](#-how-much-time-it-will-take-to-recieve-api-key) + - [🕐 How much time it will take to recieve API Key?](#-how-much-time-it-will-take-to-receive-api-key) - [🤓 Can i use this API Key for more than one project?](#-can-i-use-this-api-key-for-more-than-one-project) - - [🔞 Is there any restrications on usage or How many requests is allowed per minute?](#-is-there-any-restrications-on-usage-or-how-many-requests-is-allowed-per-minute) + - [🔞 Is there any restrications on usage or How many requests is allowed per minute?](#-are-there-any-restrictions-on-usage-or-how-many-requests-are-allowed-per-minute) - [🆓 Is this API Free forever?](#-is-this-api-free-forever) - [🤔 How often data source gets updated?](#-how-often-data-source-gets-updated) - - [🟢 What is the API's uptime?](#-what-is-the-apis-uptime) - - [🧑‍⚖️‍📝 Where can i report data related issues?](#️-where-can-i-report-data-related-issues) - - [🍕 "I need something more in response", Where can i submit my request/suggestions?](#-i-need-something-more-in-response-where-can-i-submit-my-requestsuggestions) + - [🟢 What is the API's uptime?](#🟢-what-is-the-apis-uptime) + - [📝 Where can i report data related issues?](#-where-can-i-report-data-related-issues) + - [🍕 I need something more in response, Where can i submit my request/suggestions?](#-i-need-something-more-in-response-where-can-i-submit-my-requestsuggestions) - [🙏 I am building a plugin/addon/project/app and i need your help.](#-i-am-building-a-pluginaddonprojectapp-and-i-need-your-help) - - [🤷 "I've got a custom question", What should i do?](#-ive-got-a-custom-question-what-should-i-do) + - [🤷 I have got a custom question, What should i do?](#🤷-ive-got-a-custom-question-what-should-i-do) --- -## 🔑 How do i get an API Key? +## 🔑 How do I get an API Key? You need to fill a form to [Request API Key](https://countrystatecity.in/request). _(Note: Make sure you fill the form with valid inputs)_. -Request will be reviewed by me and validated manually. +The request will be reviewed by me and validated manually. --- -## 👨‍💻 I am going to use this API for my company/client project, which email should i use in form? +## 👨‍💻 I am going to use this API for my company/client project, which email should I use in form? -You should be using company's official email or client's official email. Because incase in future there will be some announcments to be made via email. The right person should be receiving it. +You should be using the company's official email or the client's official email. It will make sure if any announcement has to be made regarding this API will be reaching the right person. __(Note: We do not share your data with the third party.)__ --- -## 🧐 "Hey, you're taking my personal informations on form", why should i give you? +## 🕐 How much time it will take to receive API Key? -Yes, i need this information because in future there will be a dashboard portal where you can login and track your API usages and generate a Key by yourself. __(Note: We do not share your data with third party.)__ +Once your API request is approved you will receive an email with API Key. _(Note: Ideal time to receive API key is within a Day or Two)_. --- -## 🕐 How much time it will take to recieve API Key? +## 🤓 Can I use this API Key for more than one project? -Once your API request is approved you will receive an email with API Key. _(Note: Ideal time to recieve API key is within a Day or Two)_. +I should suggest you use a Unique API Key for each project. That will help us easy to migrate to any new system if any to be implemented in near future. --- -## 🤓 Can i use this API Key for more than one project? +## 🔞 Are there any restrictions on usage or How many requests are allowed per minute? -I should suggest you to use a Unique API Key for your each and every project. That will help us easy to migrate to any new system if any to be implemented in near future. - ---- -## 🔞 Is there any restrications on usage or How many requests is allowed per minute? - -No, there are no such limitations has been kept at the moment to usage of API. You can use it freely but use it **Wisely**. -* Try to keep API responses cached for atleast a day. (Since this data is mostly static in nature and updates quite rarely). -* If you're just using this api to leech the data or copy the data to your database then please consider using direct source of database from here. [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database) +No, there are no such limitations that have been kept at the moment to the usage of API. You can use it freely but use it **Wisely**. +* Try to keep API responses cached for at least a day. (Since this data is mostly static in nature and updates quite rarely). +* If you're just using this API to leech the data or copy the data to your database then please consider using a direct source of the database from here. [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database) --- ## 🆓 Is this API Free forever? -TBH, I really want to keep this API Free Forever for the community but sometimes it needs a little bit of support from the users. If this API does helps you earn some bucks, then please try to [Donate](https://countrystatecity.in/donate) atleast 1% of your earning and I am sure that it will be enough to keep this API alive and Free Forever. +TBH, I want to keep this API Free Forever for the community but sometimes it needs a little bit of support from the users. If this API does help you earn some bucks, then please try to [Donate](https://countrystatecity.in/donate) at least 1% of your earning and I am sure that it will be enough to keep this API alive and Free Forever. --- ## 🤔 How often data source gets updated? -I usually try to resolve data issues in bulk and then push data updates all together to this API. So it all depends on the new release of the Database i make on the repo -- [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database) +I usually try to resolve data issues in bulk and then push data updates all together to this API. So it all depends on the new release of the Database I make on the repo -- [CountriesStatesCitiesDB](https://github.com/dr5hn/countries-states-cities-database) --- ## 🟢 What is the API's uptime? @@ -70,23 +64,21 @@ I usually try to resolve data issues in bulk and then push data updates all toge The API has had an uptime of 99.99% throughout the last 12 months. You can review the current status anytime on the Status Page. --- -## 🧑‍⚖️‍📝 Where can i report data related issues? +## 📝 Where can I report data-related issues? -Issues are most welcome. As it makes this database more stronger. Feel free to create issue by using this link - [Report an Issue](https://github.com/dr5hn/countries-states-cities-database/issues/new) +Issues are most welcome. As it makes this database stronger. Feel free to create an issue by using this link - [Report an Issue](https://github.com/dr5hn/countries-states-cities-database/issues/new) --- -## 🍕 "I need something more in response", Where can i submit my request/suggestions? +## 🍕 I need something more in response, Where can I submit my request/suggestions? You can start raising your request/suggestions here - [Raise a Request](https://github.com/dr5hn/countries-states-cities-database/discussions/151) --- -## 🙏 I am building a plugin/addon/project/app and i need your help. +## 🙏 I am building a plugin/addon/project/app and I need your help. -Well, i hardly get a free time to build a side stuff. But feel free to share your idea, i would be happy to be a part if it's awesome. +Well, I hardly get free time to build side stuff. But feel free to share your idea, I would be happy to be a part if it's awesome. --- -## 🤷 "I've got a custom question", What should i do? +## 🤷 "I've got a custom question", What should I do? Please feel free to email me at [gadadarshan[at]gmail.com](mailto:gadadarshan@gmail.com) - -