API access in splose allows you to integrate and manage your account securely with external systems.
The API enables account owners to perform actions such as retrieving data, managing payments, and updating appointments or support items.
Before you begin
As the account owner, you will need to contact the Support Team to request API access. Provide details such as your intended start date for API usage and planned use cases (e.g., integration with third-party tools like Zapier or data extraction). Wait for approval before proceeding.
How to
To locate and manage your API key and related settings, follow these steps:
Access the API Key and Settings
Navigate to Your Account: - Click on your profile icon located in the top-right corner of the splose interface. - From the dropdown menu, select "My Account."
Go to the API Section: - Within the "My Account" page, locate the tab labelled "API" or "API/keys." - Open this tab to view your API key and manage your API settings. Note: The API Keys tab becomes available only after your access request is approved and the page is refreshed.
Manage Your API Key
Once you access the API section, you will see your API key along with options for managing it. Ensure you keep your key secure and update it as needed.
If you no longer have access to your API key or encounter issues, contact splose support for assistance.
Familiarise yourself with the API documentation to understand endpoints, authentication methods, and usage guidelines. Programming knowledge is required to implement integrations using the API.
The splose API supports actions such as retrieving data (GET), adding payments (POST), retrieving payments (GET), deleting payments (DELETE), and updating appointments or support items (PUT).
Always store your API key securely to prevent unauthorised access. Splose does not retain a copy of your API key, so if you lose it, you will need to generate a new one.
Summary
The API key in splose is essential for integrating with third-party systems. You can find and manage it under the "API" or "API/keys" section of your "My Account" settings. Always keep your API key confidential to maintain security across your integrations. For further assistance, reach out to splose support or refer to additional resources in your account.
The splose API supports various actions, including retrieving data, managing payments, and updating appointments. Always refer to the API documentation for detailed guidance and ensure secure storage of your API key.