Many companies, including Smart Church Solutions, allow their customers to use Open API requests that are typically a part of an Application Programming Interface (API) that is made available to external developers, partners, or customers. These requests differ from company to company, as different companies allow their customers to interact with their software in different ways. These requests are designed to enable interaction with the company's software, services, or data in a controlled and standardized manner.
- For example, many customers use our open API requests to get event information so they can plug it into a more customized public calendar for their website (beyond what our native Public Calendar feature offers).
- However, if you are looking for a way to connect your eSPACE account to your HVAC, doors or digital signage displays, please see our integration modules that are part of FACILITeSPACE: Getting Started with FACILITeSPACE
- This article helps you setup API Keys for use with Version 2 (v2) of eSPACE API
- Version 2 uses JWT (Java Web Token) for authentication instead of Basic Authentication (HTTP based) which is used in Version 1.
- Using our open API requests is recommended for those who already have a good working knowledge of API requests, as there is no training available on this subject.
Go to the left side navigation bar > Settings > Other > Developer
After reading the Welcome information, scroll down to where you see "swagger" and you can...
- Click on the selector
- Choose either Version 2 (v2) or Version 1 (v1) of our API
As you can see Version 2 uses JWT (Java Web Token) for authentication instead of Basic Authentication (HTTP based) which is used in Version 1
Once you have made your selection, you can then confirm what each service does:
Now navigate to "Profile" by going to the left side navigation bar or by going to the top right of your dashboard and selecting "Profile" from the person icon drop-down menu.
Then, scroll to the bottom and expand API Keys
Once you have read the information on our API Keys, you can choose to Create New Key:
After clicking Create New Key, you can do the following:
- Copy the new key and keep it somewhere secure
- Enter Description (i.e. a name for the key you will understand, like "HR" or "Website")
- Click Save | REMEMBER, you can no longer see the full key after save, so be sure to copy it first!
You can create as many API keys as you desire. We recommend creating one for each system that needs to make API calls with the same level of access as your specific login!