Step 1: Getting Started
Last updated
Last updated
Sign up for a 14-day free trial of SurveySparrow. If your free trial is over, you can contact us at support@surveysparrow.dev or our developer community and we can help you with it.
Familiarize yourself with the AppNest platform and developer documentation. This is a must-do step because this opens up your ideas on what to build in this project.
Explore the Developer Portal in your SurveySparrow account:
The Developer Portal is a place where you can publish the app built using our SSDK CLI on AppNest.
To find the developer portal, Go to Settings -> Apps and Integrations -> Developer Portal
On the top-right, you will documentation and Codelabs tutorials which are adequate for you to get started.
Go through the public REST API of SurveySparrow. This is yet another important platform to go through as you will most likely be utilizing SurveySparrow's REST API in your app.
SSDK CLI - One of the key components of AppNes is the SSDK CLI which is the foundation for building apps on AppNest. Refer to the SSDK CLI's documentation for more information.
TWIGS - Who wouldn't love a react library that offers pre-built components to build a UI quickly and efficiently? That's where Twigs comes in. Explore the Twigs documentation to get started on it.
Go to the settings page - Apps and Integrations - Click on the Create a custom app button.
Fill in all the necessary details, check all the scopes, and click save.
After creating a custom app, you can find the API key in the app.
You can find all the custom apps if you scroll down to the bottom of the Apps and Integrations page.
Please note that the API quota is set to Nill in the 14-day free trial account for security concerns. Since you have provided your SurveySparrow domain on the AppNest workshop registration survey, our team will increase your API quota and notify you via a confirmation mail.
But, while building the app, if you are making an API request using the features provided by the SSDK CLI
If you are encountering 429 Errors with the message "limit exceeded", It simply means, your API quota limit for your account is exceeded.
During your SurveySparrow free trial account, your API quota is set to Nill. To extend your API quota you need to fill up our quick "API quota increase" survey using which we can extend your API quota limit. Please ignore it if you have already filled it out. If not, fill out the survey using this link.
But, while building the app, you will be making API calls to SurveySparrow Public REST API and you will be utilizing SSDK CLI's request method feature to do that. In that case, your API quota is unlimited. It is restricted to Nill only when the API calls are made outside AppNest such as in Postman.
If you have doubts, reach out to our developer community or email us at support@surveysparrow.dev
