Api Keys

NanoFrame provides and API interface for almost all site functionality. However, before any action can be taken an API key must be obtained. This is only feasible for users who have registered with nanoframe.org wither through single-sign on (Github/Google) or registered directly with the site. Once signed in, navigate to home page and look for Generate or Obtain API Keys. Each user is restricted to a single API key which has an expiration date set on it. The date is visible on the home page.

Once an API key is obtained, we recommend users make the following request to validate key activation.

GET www.nanoframe.org/foo?api=YOUR_API_KEY

If the API key activation was successful, the response should be a single JSON file containing the following entry:

{"foo": "bar"}

Any other entry indicates that the API key was either not successful created or is still being activated. We recommend checking back in around 10 minutes. If the same problem is encountered, retry generating the API key.

Once activation is successful, naviagte to page-specific API action for details.