API Settings Section Guide

Created by Ezra Weinstein, Modified on Thu, 27 Oct 2022 at 01:05 PM by Hannah Harris

In the Store Config module, use the search box or the jump to drop-down menu to get you to the API Settings section.

 

 

  • API Settings Information Button (1): Click this button to view the coreSTORE API documentation.
  • Show API Logs (2): Click the Show API Logs button to view the API Logs page to see and manage the record of every single time an API connection has been used in your coreSTORE.
  • Show Error Logs (3): Click the Show Error Logs button to view the Error Logs page to see and manage the record of every API connection error that has occurred in your coreSTORE.
  • API Keys (4): Here you will see the list of API keys that you have created through coreSTORE that have been plugged into software in order to connect the software/allow the software to communicate to coreSTORE.
    • Description (A): The descriptions of the API keys that you have created through (E) will show in this column (cannot be edited after creation, in order to edit you must create a new API key).
    • API Key Ending In (B): For security purposes, the API keys that you create through (E) are not saved/stored by coreSTORE. As a result, only the last 7 characters of each API key you have created will show in this column (cannot be edited; if you lose the rest of the API key that you created, you will need to create a new one).
    • Permissions (C): The permissions for the API keys that you have created through (E) will show in this column (cannot be edited after creation, in order to edit you must create a new API key).
    • Delete (D): Click Delete to delete the API key.
    • Add API Key (E): Click Add API Key to have the Add API Key Dialog (as seen below) pop-up on the screen, where you will create a new API key.

 

 

  • Add API Key Dialog (5): Once you click (E), the Add API Key Dialog will pop-up. This is where you will create a new API Key.
    • Description (F): Input the name of what the API key is for.
    • API Key (G): coreSTORE automatically generates an API key for you, so no need to create your own.
    • Copy to Clipboard (H): Click the Copy to Clipboard button to copy the API key to your Clipboard so that you can plug it into the software and/or save it for future reference, because once you hit (K), you will not be able to see the entire API key through coreSTORE (THIS STEP IS VERY IMPORTANT!!!!!!!!!!).
    • Permissions (J): Select from the drop-down list how much permission you want the API key to allow the software to have in accessing coreSTORE data (Read or Read/Write).
      • If you choose Read, the API key will only allow the software to read coreSTORE data.
      • If you choose Read/Write, the API key will allow the software to read and write (edit) coreSTORE data.
    • Add API Key (K): Click the Add API Key button to add the API key to coreSTORE.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article