Guide to Creating an API key as a BodyShop Booster Customer
This is only possible if you have Admin access in BodyShop Booster.
For Booster help call 800-867-6839
In this sidebar, you need to enter the following information:
Name
This is the name you want to identify this API key with. It will be shown, for example, in the conversation view. So if you name it “Website Enquiry Form” it would show something like “Website Enquiry Form created / updated this record” whenever a message is sent to the endpoint using this key.
API Type
Select Inbound Matching API - this is the only option possible at the present time
Identifier Code
Enter a code for your API key - this code cannot include spaces or punctuation. When entering a new code, you’ll need to select the +Add “[thecodeyouentered]” link at the top of the dropdown to enter it into the box. Alternatively select a preexisting code to merge data from multiple API keys together in Booster (see note below first).
If you are not certain what value to use here, just use the suggested value and it will be unique for each API key.
More information : the Identifier Code allows you to use multiple API keys under one integration. When a message is received by the API its GUID is stored along with its identifier code. You can change the value of the identifier code here, or select one in use by a different API key.
For example if you have multiple users or multiple systems that all share unique identifiers on your side, you can issue a different API key to each user or application but still allow both systems to update records based on that unique identifier for the record on your end.
Note that issuing different API keys to each user is not recommended, generating one key per external application is usually sufficient.
Add Source Tags
If a record is created by BodyShop Booster based on the inbound message, this source tag will be added to the repair record. Note that updating records that already exist do not apply the source tag.
Description
This allows you to add notes to the API key, for example to clarify for your fellow admins what this API key was generated for.