A quick tutorial on creating an API key
Step 1: Navigate to settings
On your existing FourJaw dashboard, navigate to "Settings" and click the "General" tab.
Step 2: Create an API key
At the bottom of the "General" page you'll find the API Key table.
Important: The FourJaw dashboard will only ever show you an API key once - when you first create it. Therefore, you must keep it somewhere safe, for example in a password manager. FourJaw only stores an encrypted copy for security reasons, so even the FourJaw team cannot recover a lost API key. However, you can always generate a new API key if you need to.
Click "Generate New API Key" at the top right of the table and enter a sensible name for the key. For example, name it after yourself.
Copy the key that is generated and save it in a safe location.
Step 3: Navigate to the interactive API docs
Now you have your API key, it's time to test it using the interactive API documentation!
To access the API docs, simply navigate to the link below after replacing your subdomain.
Important: Replace "yoursubdomainhere" with the subdomain of your FourJaw dashboard in the following URL.
https://yoursubdomainhere.fourjaw.app/rest/api/v0.1/docs
Paste the resulting URL into your browser address bar and you'll see the interactive docs appear.
Top tip: Bookmark or save this URL for the API docs as you will be referring to it in the future.
Step 4: Make your first request to the API
In the lefthand navigation expand "Assets" and choose "Get assets". This is an API endpoint for accessing the assets (machines, factories etc.) registered within FourJaw.
Now you will need your API Key - paste it into the box in the top right
You're ready to go! Press "Send API Request".
Now you'll see the interactive documentation in action - you've just made a request to the API and should see the response appear.
Congratulations, that's your data securely returned from the FourJaw API!
You've now completed this tutorial. For more detail about the "Get assets" endpoint and the data it returns, please see the guidance here.