Website
Home
Database
News
Submissions queue
Community
Forum
Clubs
Discord
Members
Tools
ROM Patcher
ROM Hasher
Pages
Support us
Learn Romhacking
About
Contact Us
Help & Legal Pages
Guest
Login
Forum
Entries
News
Settings
Documentations
API Documentation
API Usage
JavaScript is disabled. For a better experience, please enable JavaScript in your browser before proceeding.
You are using an out of date browser. It may not display this or other websites correctly.
You should upgrade or use an
alternative browser
.
Reply to thread
Message
<blockquote data-quote="Benjamin" data-source="post: 6932" data-attributes="member: 192"><p>The Romhack Plaza API allows you to retrieve information about entries, news, and metadata to include in your projects.</p><p></p><p><span style="font-size: 22px"><strong>How do I create an API key?</strong></span></p><p></p><p>First, you need to have an account on the site. Then, click the “Settings” button in the top bar and select “API Keys.”</p><p></p><p>[ATTACH=full]381[/ATTACH]</p><p></p><p>You’ll then be taken to the interface where you can manage your API keys, view when certain keys were last used, check their expiration dates, and revoke them if you wish.</p><p></p><p>[ATTACH=full]380[/ATTACH]</p><p></p><p>You’ll then see the button to create an API key. You can choose a name, the scopes for this API key, and its expiration date. If you don’t set an expiration date, it will remain valid indefinitely until you revoke it.</p><p></p><p>[ATTACH=full]379[/ATTACH]</p><p></p><p>Finally, your API key will appear only once after it’s created, so be sure to copy it right away!</p><p></p><p>[ATTACH=full]378[/ATTACH]</p><p></p><p><span style="font-size: 22px"><strong>How to Use the API?</strong></span></p><p></p><p>All API routes are structured as follows: <a href="https://romhackplaza.org/api/v1/" target="_blank">https://romhackplaza.org/api/v1/</a><Endpoint></p><p></p><p>All endpoints require authentication, which means you’ll need your API key. To do this, you must include your API key in the header as follows:</p><p></p><p>Name: Authorization</p><p>Value: Bearer <API KEY></p><p></p><p>The response is in JSON.</p><p>All valid API responses will have an ‘ok’ field set to true, and almost all will have a ‘data’ field containing the data detailed in the list of endpoints.</p><p></p><p><span style="font-size: 22px"><strong>What Are the API Limits?</strong></span></p><p></p><p>Once authenticated, the maximum allowed is 30 requests per minute. This is a test value subject to change.</p><p></p><p>You are also limited to one API key if you have not supported the site. In that case, on the API key management page, you’ll see a message if you want more details about donations.</p><p></p><p>Any use of multiple accounts to circumvent this limit may result in a permanent ban of your accounts, as well as the removal of all your content from the site.</p><p></p><p><span style="font-size: 22px"><strong>And for the XenForo API?</strong></span></p><p></p><p>Since a significant portion of the site uses XenForo, large projects may need resources on this platform. In that case, you can contact us via the contact form to request an API key if your project meets our criteria.</p><p></p><p><strong>If you have any questions about the API, please post your questions below the documentation.</strong></p></blockquote><p></p>
[QUOTE="Benjamin, post: 6932, member: 192"] The Romhack Plaza API allows you to retrieve information about entries, news, and metadata to include in your projects. [SIZE=6][B]How do I create an API key?[/B][/SIZE] First, you need to have an account on the site. Then, click the “Settings” button in the top bar and select “API Keys.” [ATTACH type="full"]381[/ATTACH] You’ll then be taken to the interface where you can manage your API keys, view when certain keys were last used, check their expiration dates, and revoke them if you wish. [ATTACH type="full"]380[/ATTACH] You’ll then see the button to create an API key. You can choose a name, the scopes for this API key, and its expiration date. If you don’t set an expiration date, it will remain valid indefinitely until you revoke it. [ATTACH type="full"]379[/ATTACH] Finally, your API key will appear only once after it’s created, so be sure to copy it right away! [ATTACH type="full"]378[/ATTACH] [SIZE=6][B]How to Use the API?[/B][/SIZE] All API routes are structured as follows: [URL]https://romhackplaza.org/api/v1/[/URL]<Endpoint> All endpoints require authentication, which means you’ll need your API key. To do this, you must include your API key in the header as follows: Name: Authorization Value: Bearer <API KEY> The response is in JSON. All valid API responses will have an ‘ok’ field set to true, and almost all will have a ‘data’ field containing the data detailed in the list of endpoints. [SIZE=6][B]What Are the API Limits?[/B][/SIZE] Once authenticated, the maximum allowed is 30 requests per minute. This is a test value subject to change. You are also limited to one API key if you have not supported the site. In that case, on the API key management page, you’ll see a message if you want more details about donations. Any use of multiple accounts to circumvent this limit may result in a permanent ban of your accounts, as well as the removal of all your content from the site. [SIZE=6][B]And for the XenForo API?[/B][/SIZE] Since a significant portion of the site uses XenForo, large projects may need resources on this platform. In that case, you can contact us via the contact form to request an API key if your project meets our criteria. [B]If you have any questions about the API, please post your questions below the documentation.[/B] [/QUOTE]
Insert quotes…
Verification
Post reply
Documentations
API Documentation
API Usage
This site uses cookies to help personalise content, tailor your experience and to keep you logged in if you register.
By continuing to use this site, you are consenting to our use of cookies.
Accept
Learn more…
Back
Top