Pike13 API
You can use the Pike13 Application Programming Interface (API) to integrate things like staff schedules, client profiles, and location info into your website.
In This Article
- Who can use this feature?
- Registering and Approval of Your App
- Pike13 APIs and Webhooks
- Coding for the API
Who can use this feature?
- Pike13 Plans: ✅Premium, ✅Advanced, ✅Essential
- User Roles: ✅Primary Owner, ✅Owner, ❌Manager, ❌Staff, ❌Limited Staff
Registering and Approval of Your App
Begin by registering your app. After registering, your application will require formal approval from Pike13 before you can connect to the API.
Note:
After registering you application’s unique API Client ID and Secret will be displayed immediately. Make sure to copy and save these credentials securely, as you will need them once your application has been approved.
Pike13 APIs and Webhooks
Once your registration is approved, you will have access to use both Core API and Reporting API.
-
Core API allows apps to perform business processes. Creating a client, retrieving their custom fields, and checking them into a class are examples of what's possible with this Pike13 API.
-
Reporting API allows apps to retrieve and aggregate business data at business and franchise levels. Aggregating revenue by quarter, retrieving every piece of merchandise ever sold by a certain staff member, or finding the client who has contributed the highest revenue to a business are examples of what's possible with this Pike13 API.
-
Webhooks allow receiving information from Pike13 when certain actions take place. This way, you can have near-live information without making as many API calls directly to Pike13.
Coding for the API
Use the Core API and Reporting API documentation to explore all that is available from each Pike13 API. Check out the Authentication section to learn about our OAuth2 flow.
Here are some examples to get started:
For any questions, please contact api-support@pike13.com.