Difference between revisions of "Legacy THNapi:FAQ"
From Neocron Wiki
(Work in progress) |
(FAQ update) |
||
| Line 1: | Line 1: | ||
| − | + | == What is the THN API? == | |
| − | The THN API is a | + | The THN API is a web services for fan sites to insert item DB data into their own sites or applications. |
| − | + | There will be a set of PHP libraries released that fansite owners put in their sites, which will connect and pull the data from the item DB. | |
| + | |||
| + | == When will the THN API be released for other fansites to use? == | ||
There is no date set. There are quite a few issues to be resolved before I can allow the THN API to be released. Some are technical issues, and some are cosmetic issues. | There is no date set. There are quite a few issues to be resolved before I can allow the THN API to be released. Some are technical issues, and some are cosmetic issues. | ||
| − | + | == Will the THN API libraries be open source? == | |
| − | Yes, but it hasn't been decided | + | Yes, but it hasn't been finally decided what license. It is most likely it will be GPLv3 at this stage. [http://www.gnu.org/licenses/quick-guide-gplv3.html link] |
| − | + | == Will there be support for .NET? == | |
| − | + | The THN API is a Web service. It is possible to use the use the '''Add web reference''' in Visual Studio 2005. The location of the WSDL is at [http://www.techhaven.org/db/view/THNapiWebService?wsdl http://www.techhaven.org/db/view/THNapiWebService?wsdl] but the URL location will be moving in the next release of the ItemDB/THN api. | |
| − | + | == What will I need to use the THN API PHP library? == | |
# You will need a THN API key | # You will need a THN API key | ||
| − | # | + | # A good knowledge of PHP coding |
# If you wish to customise the layout, you will need a good knowledge and understanding of CSS | # If you wish to customise the layout, you will need a good knowledge and understanding of CSS | ||
| − | # You will need a web server with at least PHP5.2.5 PHP4 is not supported at all, as the libraries uses | + | # You will need a web server with at least PHP5.2.5 PHP4 is not supported at all, as the libraries uses features not available PHP4, and also support for PHP4 is being dropped. The libraries should work on PHP5.0.x to PHP 5.2.4, but the libraries have not been tested on these versions of PHP. |
| − | + | == Why do need an API Key? == | |
This is so we know who is using the THN API, so we can contact users with impending changes that could break your website, and also to ensure the THN API is being used correctly. | This is so we know who is using the THN API, so we can contact users with impending changes that could break your website, and also to ensure the THN API is being used correctly. | ||
| − | + | == Who is using/testing the THN API now? == | |
| − | * The NC- | + | * The NC-Wiki - Is using the current THN API PHP libraries |
| − | * The Rares Database - It is pulling | + | * The Rares Database - It is pulling an XML feed of rares data so that Item data can be shown in the rares DB. |
* The Ultimate Launcher - There is a in game command to search for items while you are playing Neocron. | * The Ultimate Launcher - There is a in game command to search for items while you are playing Neocron. | ||
Revision as of 13:47, 4 July 2008
What is the THN API?
The THN API is a web services for fan sites to insert item DB data into their own sites or applications.
There will be a set of PHP libraries released that fansite owners put in their sites, which will connect and pull the data from the item DB.
When will the THN API be released for other fansites to use?
There is no date set. There are quite a few issues to be resolved before I can allow the THN API to be released. Some are technical issues, and some are cosmetic issues.
Will the THN API libraries be open source?
Yes, but it hasn't been finally decided what license. It is most likely it will be GPLv3 at this stage. link
Will there be support for .NET?
The THN API is a Web service. It is possible to use the use the Add web reference in Visual Studio 2005. The location of the WSDL is at http://www.techhaven.org/db/view/THNapiWebService?wsdl but the URL location will be moving in the next release of the ItemDB/THN api.
What will I need to use the THN API PHP library?
- You will need a THN API key
- A good knowledge of PHP coding
- If you wish to customise the layout, you will need a good knowledge and understanding of CSS
- You will need a web server with at least PHP5.2.5 PHP4 is not supported at all, as the libraries uses features not available PHP4, and also support for PHP4 is being dropped. The libraries should work on PHP5.0.x to PHP 5.2.4, but the libraries have not been tested on these versions of PHP.
Why do need an API Key?
This is so we know who is using the THN API, so we can contact users with impending changes that could break your website, and also to ensure the THN API is being used correctly.
Who is using/testing the THN API now?
- The NC-Wiki - Is using the current THN API PHP libraries
- The Rares Database - It is pulling an XML feed of rares data so that Item data can be shown in the rares DB.
- The Ultimate Launcher - There is a in game command to search for items while you are playing Neocron.
