Latest Neocron News and Information
- New test server patch #564 has been released to Vedeena
Difference between revisions of "User:Brammers/THN API Agreement"
m (Brammers moved page User:Brammers/THN API Aggrement to User:Brammers/THN API Agreement: Spelling :() |
|||
Line 5: | Line 5: | ||
== Definitions == | == Definitions == | ||
− | * THN Account: A user account obtained from the Tech Haven Network consisting of your Username, password and email | + | * THN Account: A user account obtained from the Tech Haven Network consisting of your Username, password and email. |
− | * THN API Key: An API key to access the THI API. This is supplied to you by the Tech Haven Network or via the API account console. | + | * THN API Key: An API key to access the THI API. This is supplied to you by the Tech Haven Network or via the Tech Haven Network API account console. |
* API: Resources accessed using the THN API key | * API: Resources accessed using the THN API key | ||
− | * THN: The Tech Haven Network. This covers https://techhaven.org/ sub-domains | + | * THN: The Tech Haven Network. This covers https://techhaven.org/ and all it’s sub-domains. |
− | * THN CDN: Content delivery network used for delivery of assets to end user. | + | * THN CDN: Content delivery network used for delivery of assets to the end user. |
− | * Community: Covers members of the THN and the Neocron community members https://www.neocron-game.com/ and all it’s sub-domains | + | * Community: Covers members of the THN and the Neocron community members https://www.neocron-game.com/ and all it’s sub-domains. |
* THN Administration: Members of the Tech Haven Network administration team - the current list is at https://forum.techhaven.org/memberlist.php?mode=group&g=2007 | * THN Administration: Members of the Tech Haven Network administration team - the current list is at https://forum.techhaven.org/memberlist.php?mode=group&g=2007 | ||
Line 30: | Line 30: | ||
* The THN Api key consists of 2 parts The API key and API secret. | * The THN Api key consists of 2 parts The API key and API secret. | ||
* You may use it to build a Neocron fan website or application that is connected with the Neocron game at https://www.neocron-game.com/ | * You may use it to build a Neocron fan website or application that is connected with the Neocron game at https://www.neocron-game.com/ | ||
+ | * Your application should cache responses from the THN Api to avoid unnecessary querying of endpoints. | ||
+ | * The THN may rate limit queries or heavy usage of the THN API. | ||
* At this time the THN API key may only be used on API services at https://db.techhaven.org/ Other API's will be offered in the future. | * At this time the THN API key may only be used on API services at https://db.techhaven.org/ Other API's will be offered in the future. | ||
* Some API features are internal for the THN's use only. | * Some API features are internal for the THN's use only. | ||
Line 38: | Line 40: | ||
* The THN does not use versioning on it's API's. Although it is desirable to maintain backward compatibility, the THN may make a breaking change to the API. | * The THN does not use versioning on it's API's. Although it is desirable to maintain backward compatibility, the THN may make a breaking change to the API. | ||
* Your application or website must acknowledge that the data is from the Tech Haven Network and is copyrighted. | * Your application or website must acknowledge that the data is from the Tech Haven Network and is copyrighted. | ||
− | * Your application or website must link to the Tech Haven Network with an acknowledgement to the source of your data. | + | * Your application or website must link to the Tech Haven Network with an acknowledgement to the source of your data. |
== Conditions for the THN Items DB API == | == Conditions for the THN Items DB API == | ||
Line 51: | Line 53: | ||
* There is no private support given to using the API except in the area of issuing API keys, permissions around the API keys or security issues. | * There is no private support given to using the API except in the area of issuing API keys, permissions around the API keys or security issues. | ||
− | * Support regarding the use of the API is supported in the public THN forums to | + | * Support regarding the use of the API is supported in the public THN forums or in the THN wiki, in the THNapi discussion namespace. This is to help other API users to be able to use the API. |
− | * Bugs and feature requests can be reported or suggested in the public THN forums. | + | * Bugs and feature requests can be reported or suggested in the public THN forums or in the THN wiki, in the THNapi discussion namespace. |
* Security issues should be reported directly to the members of the THN Administration. You will not communicate security issues to anyone outside the THN Administration. | * Security issues should be reported directly to the members of the THN Administration. You will not communicate security issues to anyone outside the THN Administration. | ||
− | * The THN Administration may ask for your API key to diagnose an issue, but will never ask for the API secret. You should never give the API secret part of your key. | + | * The THN Administration may ask for your API key to diagnose an issue, but will never ask for the API secret. You should never give the API secret part of your key to the THN Administration. |
== Code of conduct within the community == | == Code of conduct within the community == |
Latest revision as of 13:21, 15 May 2020
THN API Agreement
By accepting this Agreement, either by accessing or using the API, or authorising or permitting any individual to access or use the API, You agree to be bound by this Agreement. If You are entering into this Agreement on behalf of a company, organisation or another legal entity (an “Entity”), You are agreeing to this Agreement for that Entity and representing to Tech Haven Network that You have the authority to bind such Entity and its Affiliates to this Agreement, in which case the terms “Licensee”, “You”, “Your” or a related capitalised term herein shall refer to such Entity and its Affiliates. If You do not have such authority, or if You do not agree with this Agreement, You must not accept this Agreement and may not access nor use the THN API.
Definitions
- THN Account: A user account obtained from the Tech Haven Network consisting of your Username, password and email.
- THN API Key: An API key to access the THI API. This is supplied to you by the Tech Haven Network or via the Tech Haven Network API account console.
- API: Resources accessed using the THN API key
- THN: The Tech Haven Network. This covers https://techhaven.org/ and all it’s sub-domains.
- THN CDN: Content delivery network used for delivery of assets to the end user.
- Community: Covers members of the THN and the Neocron community members https://www.neocron-game.com/ and all it’s sub-domains.
- THN Administration: Members of the Tech Haven Network administration team - the current list is at https://forum.techhaven.org/memberlist.php?mode=group&g=2007
THN API
Before you can be granted a THN API Key:-
- You must have an active THN Account before being granted a THN API key
- Your THN Account must be at least 3 months old and accessed within the last 3 months.
- Your THN Account must be in a state of good standing.
- Your THN Account email address must be uptodate.
- You must have a reasonable understanding of accessing a web API.
- You do not own or assume any rights to the data obtained from the THN API.
- You will be asked to give a brief outline of your use of the API. This is to ensure you are granted the right permissions on the API.
- You acknowledge that the data or other assets is copyrighted by the Tech Haven Network.
Use of THN API
- The THN Api key consists of 2 parts The API key and API secret.
- You may use it to build a Neocron fan website or application that is connected with the Neocron game at https://www.neocron-game.com/
- Your application should cache responses from the THN Api to avoid unnecessary querying of endpoints.
- The THN may rate limit queries or heavy usage of the THN API.
- At this time the THN API key may only be used on API services at https://db.techhaven.org/ Other API's will be offered in the future.
- Some API features are internal for the THN's use only.
- You must store the API key and secret securely.
- You must not publish the API key and secret publicly or in a publicly accessible format.
- In the event of accidentally publishing the key, you should immediately revoke the key regardless how limited you think the scope of exposure is.
- The THN reserves the right to revoke an API key without notice.
- The THN does not use versioning on it's API's. Although it is desirable to maintain backward compatibility, the THN may make a breaking change to the API.
- Your application or website must acknowledge that the data is from the Tech Haven Network and is copyrighted.
- Your application or website must link to the Tech Haven Network with an acknowledgement to the source of your data.
Conditions for the THN Items DB API
- These additional conditions refer to API access at https://db.techhaven.org/
- You may be given access to use the Item DB CDN for the item images. The THN reserve the right to refuse access to the CDN or remove access without notice.
- You may be given access to download the item images you have access to. The THN is not obliged to offer this service.
- Only limited sets of data is made available to users of the Items DB API. You may request additional access, but the THN is under no obligation to grant access.
- Any errors in the item data should be submitted for update and review at https://db.techhaven.org/
Support
- There is no private support given to using the API except in the area of issuing API keys, permissions around the API keys or security issues.
- Support regarding the use of the API is supported in the public THN forums or in the THN wiki, in the THNapi discussion namespace. This is to help other API users to be able to use the API.
- Bugs and feature requests can be reported or suggested in the public THN forums or in the THN wiki, in the THNapi discussion namespace.
- Security issues should be reported directly to the members of the THN Administration. You will not communicate security issues to anyone outside the THN Administration.
- The THN Administration may ask for your API key to diagnose an issue, but will never ask for the API secret. You should never give the API secret part of your key to the THN Administration.
Code of conduct within the community
In the interest of fostering an open and welcoming environment the THN wants the community to be a harassment-free experience for everyone, regardless of age, body size, disability, ethnic origin, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, religion, or sexual identity and orientation.
Examples of behaviour that contributes to creating a positive environment include:
- Using welcoming and inclusive language.
- Being respectful of differing viewpoints and experiences.
- Gracefully accepting constructive criticism.
- Focusing on what is best for the community.
- Showing empathy towards other community members.
Examples of unacceptable behaviour by participants include:
- The use of sexualised language or imagery and unwelcome sexual attention or advances.
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others' private information, such as a physical or electronic address, without explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.
- Engaging in conduct that is of decrement to members of the community. eg Copying code or data without permission.
- Any activity that deliberately decrements the standing of the Tech Haven Network within the community.
Other conditions
- The THN reserve the right to amend this agreement at any time.
- It is the responsibility of the THN API Key owner to check for updates.
- The latest version of this agreement will be kept at https://wiki.techhaven.org/Neocron_Wiki:THN_API_Agreement Any changes will viewable through the wiki history for the page.