Overview
The Stageup API is designed to enable developers to integrate their applications or services with the Stageup platform. Through the API, you can programmatically access and manage order information, product data, customer data, and more.
Authentication Methods
To call the Stageup API, you must use the following authentication methods:
- API Key Authentication: Include the API key issued from the admin page in the request header for authentication.
- API-KEY: An API KEY is automatically issued for each customer. Requests are made using this API-KEY.
Webhook Functionality
Stageup provides webhooks for various events. By setting up webhooks, you can receive real-time notifications when specific events occur (e.g., new orders, payment completion, shipping status changes, etc.).
How to Set Up Webhooks
- Go to the API settings menu in the admin page.
- Register your webhook URL.
- Select the event types you want to receive.
- Set up a signature key for webhook server security.
Webhook Types
- General Webhook: Basic webhook setup that allows you to set URLs for test/production environments separately.
- GamePot Webhook: Integrates with GamePot service to handle payment, authentication, and other events. Webhooks are automatically set up through APIs provided by GamePot.
- Advanced Webhook: Advanced webhooks that allow you to directly configure HTTP methods, headers, body templates, etc. Use this for complex integration requirements.
Webhook Testing
After setting up your webhook server, you can send test events from the admin page to verify proper operation.
Error Handling
API responses use standard HTTP status codes:
- 200: Success
- 400: Bad Request
- 401: Authentication Failed
- 403: No Permission
- 404: Resource Not Found
- 500: Server Error
All error responses include error codes and messages that help identify the cause of the problem.
Support and Contact
If you encounter issues while using the API or need additional information, you can get support through the following channels:
- Email: [email protected]
- Developer Discord: https://discord.gg/PVZDh8dJ
API Changes and Updates
API changes and new features are announced through the developer blog and email newsletter.