Snowpal AI + API: Build Apps Faster, Cheaper, Better: APIs on AWS

Snowpal APIs: Integration, Subscription, Licensing

Varun Palaniappan — Thu, 20 Feb 2025 23:17:54 GMT

In this conversation, Krish Palaniappan introduces Snowpal APIs, detailing their functionalities, deployment options, and the benefits they offer to developers. He emphasizes the ease of integration, the cost-effectiveness of using these APIs, and the support available for users. The discussion also highlights the importance of community engagement and the resources provided to assist developers in utilizing the APIs effectively.

Takeaways

• Snowpal APIs provide a comprehensive suite of backend services.
• Developers can focus on core customer problems without backend distractions.
• APIs are available on multiple platforms, including AWS Marketplace.
• Integration is straightforward with quick access to API keys.
• Cost-effective solutions are available for startups and small teams.
• APIs support various functionalities across multiple industries.
• User feedback indicates high satisfaction with ease of integration.
• Regular updates and community participation are encouraged.
• Documentation and resources are abundant for developers.
• APIs can significantly reduce time to market for new applications.

Chapters

00:00 Introduction to Snowpal APIs
04:08 Engagement and Deployment Options
08:56 Functionality and Features of APIs
12:35 Cost-Effectiveness and Use Cases
16:48 Community Engagement and Resources

Video

Transcript

Snowpal APIs: Introduction, Integration, Subscription, Licensing

35.9KB ∙ PDF file

Download

Video on Other Platforms

Snowpal Products

Snowpal API on AWS Marketplace: Steps to Integrate

Varun Palaniappan — Fri, 14 Feb 2025 00:33:50 GMT

In this conversation, ⁠Krish Palaniappan⁠ discusses the process of publishing APIs on the AWS API Gateway, focusing on the experience of subscribing to APIs through the AWS Marketplace. He explains the steps involved in obtaining an API key, integrating APIs, and utilizing developer resources. The conversation emphasizes the importance of efficient API management and the support provided to developers for seamless integration.

Takeaways

Publishing APIs on AWS requires careful planning and execution.
Subscribing to APIs can significantly reduce time to market.
The AWS Marketplace offers various subscription models for APIs.
API keys and product codes are essential for integration.
Documentation is crucial for both developers and product managers.
Postman collections facilitate easier API testing and integration.
User registration endpoints are vital for onboarding users.
Data management can be handled through various database options.
Understanding the architecture behind APIs can enhance integration efforts.
Future resources will be available to assist developers further.

Chapters

00:00 Introduction to AWS API Gateway Publishing
03:08 Engaging with AWS Marketplace for API Subscription
06:14 Understanding API Key and Product Code Management
08:50 Exploring API Documentation and Developer Resources
11:45 Integrating APIs: User Registration and Data Management
15:04 Final Thoughts on API Integration and Future Resources

Video

Transcript

Snowpal API on AWS Marketplace: Steps to Integrate

37.3KB ∙ PDF file

Download

Video on Other Platforms

Snowpal Products

APIs and Reusability (with charts as an example)

Varun Palaniappan — Tue, 07 Jan 2025 00:07:42 GMT

In this conversation, ⁠Krish Palaniappan⁠ discusses the significance of APIs and reusability in software development. He emphasizes how leveraging existing APIs can help organizations save time, reduce costs, and focus on core customer problems. The discussion includes examples of how APIs can enhance product offerings and the importance of not reinventing the wheel in development. Krish also highlights the various models available for utilizing APIs and the benefits they bring to businesses.

Takeaways

APIs provide essential building blocks for applications.
Reusability in development leads to faster market entry.
Organizations should focus on core competencies and customer needs.
Leveraging existing APIs can save time and resources.
Investing in reusable components enhances product quality.
APIs can be integrated quickly and efficiently.
Using APIs allows teams to avoid reinventing the wheel.
Snowpal offers a suite of APIs for various needs.
Understanding the importance of reusability is crucial for success.
APIs can help startups and mid-sized organizations thrive.

Chapters

00:00 Introduction to APIs and Reusability

04:41 The Importance of Reusability in Development

12:47 Leveraging Existing Components for Efficiency

23:13 Conclusion and Future Directions

Podcast

(For video version, go to Spotify or Apple)

Transcript

APIs and Reusability (with charts as an example)

40.4KB ∙ PDF file

Download

Podcast on Other Platforms

Snowpal Products

Walkthrough of Snowpal APIs

Krish Palaniappan — Wed, 27 Mar 2024 19:36:41 GMT

APIs on AWS Marketplace

Overview

List of APIs provided by Snowpal.
Explanation of each API’s purpose and relevance.
Mention of industry agnosticism and domain-specific APIs.

Detailed Description of Individual APIs

Building Blocks API: Overview of its endpoints and generic problem-solving capability.
Content Management API: Overview of its endpoints and relevance for content management solutions.
Project Management API: Overview of its endpoints and relevance for project management solutions.
Classroom API: Overview of its endpoints and relevance for the education technology industry.
Conversation API: Overview of its endpoints and functionality for in-app conversations.
Status API: Overview of its endpoints and relevance for managing statuses and team performance.
Access Control List API: For all your access control needs (privileges, roles, users, teams).
Custom Attribution API: Build (all kinds of) forms quicker by leveraging this API.

Integration and Ease of Use

Discussion on mixing and matching APIs and endpoints.
Mention of easy integration into existing systems.
Brief overview of sample code and SDK availability.

Testimonials and Usage

Mention of Snowpal’s APIs being used in their own products.
Reference to thousands of users utilizing Snowpal APIs.

Video

Transcript

Snowpal API: High Level Introduction

20.9KB ∙ PDF file

Download

Snowpal Products

Custom Attribution API: Custom Forms (Text, Date, Number, File, Single Select, Multiselect)

Varun Palaniappan — Thu, 14 Mar 2024 20:19:59 GMT

Get API Key

This conversation provides an overview of Snowpal Custom Attribution API and its benefits. It explains how to access the API documentation and explores the different attribute types supported by the API. The conversation also discusses the fundamental building blocks of the API, including nested single select attributes and attribute bags. It highlights the simplicity of attribute creation and association, as well as the licensing and provisioning options available. The conversation concludes by providing guidance on getting started with the API and accessing support.

Takeaways

Snowpal Custom Attribution API is a suite of APIs that provides a range of functionality for creating and managing custom attributes.
The API supports different attribute types, including text, number, date, file, single select, multi select, and nested attributes.
Attribute bags allow for the grouping and association of multiple attributes, simplifying the process of creating and managing resources.
The API offers licensing and provisioning options, allowing users to integrate it into their infrastructure in a way that suits their needs.
Getting started with the API is straightforward, and support is available through professional services and documentation.

Chapters

00:00 Introduction to Snowpal Custom Attribution API

01:23 Accessing the API Documentation

01:51 Exploring the Custom Attribution API

03:12 Building Without the API

04:35 Benefits of Using the Custom Attribution API

05:02 Different Attribute Types

06:36 Fundamental Building Blocks of the API

08:17 Nested Single Select Attributes

10:14 Attribute Bags

12:51 Simplifying Attribute Creation and Association

15:03 Associating Attributes with Resources

17:28 Licensing and Provisioning Options

20:54 Getting Started and Support

22:13 Next Steps and Conclusion

Video

Transcript

Custom Attribution API: Custom Forms (Text, Date, Number, File, Single Select, Multiselect)

41.7KB ∙ PDF file

Download

Summary

Description of the Custom Attribution API:

Explains the essence and functionality of the Custom Attribution API.
Provides examples and scenarios where the API can be beneficial.
Describes how the API simplifies development processes and saves time, effort, and resources.

Technical Details and Functionality:

Discusses the different attribute types supported by the API (text, number, date, file, single select, multi-select, nested single select).
Talks about implementation methods and considerations for utilizing the API.
Explains the concept of “attribute bags” and their role in organizing and associating attributes with resources.

API Usage and Integration:

Discusses integration steps and best practices for using the API effectively.
Mentions endpoint functionalities and their relevance to developers.
Explains licensing models and deployment options for the API.

Additional Resources and Support:

Provides information about accessing developer documentation, SDKs, and other resources related to the Custom Attribution API.
Mentions professional services and support options available for customers.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Snowpal: Building Blocks API Endpoints

Krish Palaniappan — Thu, 14 Mar 2024 00:25:15 GMT

Get API Key

What’s below is a list of some of the endpoints in Snowpal’s Building Blocks API. Yeah, just a collective list of endpoints from a single API we support. If you see duplicated paths, it’s because their HTTP Verbs are different (GET vs POST, etc).

Now, if you have a business problem that cannot be mapped to these endpoints, it’s highly likely it would be catered to by one of the many other APIs we support. Long story short, if you have a problem that’s so unique that none of our APIs, and their collective endpoints, do not support, we would LOVE to know what that is! (But, we can help you even then — trust me!)

https://gateway.snowpal.com/dashboard/combined-responses
https://gateway.snowpal.com/dashboard/recently-modified
https://gateway.snowpal.com/dashboard/unread-count
https://gateway.snowpal.com/dashboard/recently-modified/keys
https://gateway.snowpal.com/dashboard/due-shortly/pods-and-tasks
https://gateway.snowpal.com/dashboard/due-shortly/blocks
https://gateway.snowpal.com/dashboard/notifications/unread-status
https://gateway.snowpal.com/dashboard/conversations/unread-status
https://gateway.snowpal.com/charts/dashboard/keys-blocks-pods
https://gateway.snowpal.com/charts/dashboard/system-keys
https://gateway.snowpal.com/charts/dashboard/keys/filters
https://gateway.snowpal.com/charts/dashboard/system-keys/filters
https://gateway.snowpal.com/charts/dashboard/block-types
https://gateway.snowpal.com/charts/dashboard/pod-types
https://gateway.snowpal.com/charts/dashboard/scales
https://gateway.snowpal.com/charts/dashboard/task-status
https://gateway.snowpal.com/keys
https://gateway.snowpal.com/keys
https://gateway.snowpal.com/keys/by-template
https://gateway.snowpal.com/keys/:id
https://gateway.snowpal.com/keys/:id
https://gateway.snowpal.com/keys/archived
https://gateway.snowpal.com/pods/:id/linked-to/keys
https://gateway.snowpal.com/blocks/:id/linked-to/keys
https://gateway.snowpal.com/keys/filtered/by-type
https://gateway.snowpal.com/keys/archive
https://gateway.snowpal.com/keys/:id/archive
https://gateway.snowpal.com/keys/:id/unarchive
https://gateway.snowpal.com/keys/:id/description
https://gateway.snowpal.com/charts/keys/:id/blocks-pods
https://gateway.snowpal.com/charts/keys/:id/filters
https://gateway.snowpal.com/charts/keys/:id/block-types
https://gateway.snowpal.com/charts/keys/:id/pod-types
https://gateway.snowpal.com/charts/keys/:id/scales
https://gateway.snowpal.com/charts/keys/:id/linked-resources
https://gateway.snowpal.com/charts/keys/:id/scales/:scale-id/scale-values
https://gateway.snowpal.com/charts/keys/:id/task-status
https://gateway.snowpal.com/keys/:id/checklists
https://gateway.snowpal.com/keys/:id/checklists
https://gateway.snowpal.com/keys/:id/checklists/reorder
https://gateway.snowpal.com/keys/:id/checklists/:checklist-id
https://gateway.snowpal.com/keys/:id/checklists/:checklist-id
https://gateway.snowpal.com/keys/:id/checklists/:checklist-id/checklist-items
https://gateway.snowpal.com/keys/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/keys/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/keys/:id/checklists/:checklist-id/checklist-items/reorder
https://gateway.snowpal.com/keys/:id/notes
https://gateway.snowpal.com/keys/:id/notes
https://gateway.snowpal.com/key-notes/:id
https://gateway.snowpal.com/key-notes/:id
https://gateway.snowpal.com/keys/:id/tasks
https://gateway.snowpal.com/keys/:id/tasks
https://gateway.snowpal.com/key-tasks/:id
https://gateway.snowpal.com/key-tasks/:id
https://gateway.snowpal.com/keys/:id/tasks/reorder
https://gateway.snowpal.com/keys/:id/pods
https://gateway.snowpal.com/keys/:id/pods
https://gateway.snowpal.com/keys/:id/pods/by-template
https://gateway.snowpal.com/keys/:id/pods/available-to-link
https://gateway.snowpal.com/keys/:id/pods/:pod-id/link
https://gateway.snowpal.com/keys/:id/pods/:pod-id/unlink
https://gateway.snowpal.com/pods/:id
https://gateway.snowpal.com/pods/:id
https://gateway.snowpal.com/pods/:id/by-completion-status
https://gateway.snowpal.com/pods/:id/scale-value
https://gateway.snowpal.com/pods/:id/pod-types/:pod-type-id
https://gateway.snowpal.com/pods/:id/pod-types
https://gateway.snowpal.com/pods/:id/scales/:scale-id
https://gateway.snowpal.com/pods/:id/scales
https://gateway.snowpal.com/pods/:id/archive
https://gateway.snowpal.com/pods/archived
https://gateway.snowpal.com/pods/:id/unarchive
https://gateway.snowpal.com/pods/archive
https://gateway.snowpal.com/pods/:id/description
https://gateway.snowpal.com/pods/:id/allow-archival
https://gateway.snowpal.com/pods/:id/copy
https://gateway.snowpal.com/pods/:id/move
https://gateway.snowpal.com/pods/:id/attachments
https://gateway.snowpal.com/pods/:id/attachments
https://gateway.snowpal.com/key-pod-attachments/:id/rename
https://gateway.snowpal.com/key-pod-attachments/:id
https://gateway.snowpal.com/pods/:id/checklists
https://gateway.snowpal.com/pods/:id/checklists
https://gateway.snowpal.com/pods/:id/checklists/reorder
https://gateway.snowpal.com/pods/:id/checklists/:checklist-id
https://gateway.snowpal.com/pods/:id/checklists/:checklist-id
https://gateway.snowpal.com/pods/:id/checklists/:checklist-id/checklist-items
https://gateway.snowpal.com/pods/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/pods/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/pods/:id/checklists/:checklist-id/checklist-items/reorder
https://gateway.snowpal.com/pods/:id/comments
https://gateway.snowpal.com/pods/:id/comments
https://gateway.snowpal.com/pod-comments/:id
https://gateway.snowpal.com/pod-comments/:id
https://gateway.snowpal.com/pods/:id/notes
https://gateway.snowpal.com/pods/:id/notes
https://gateway.snowpal.com/pod-notes/:id
https://gateway.snowpal.com/pod-notes/:id
https://gateway.snowpal.com/pods/:id/tasks
https://gateway.snowpal.com/pods/:id/tasks
https://gateway.snowpal.com/pod-tasks/:id
https://gateway.snowpal.com/pod-tasks/:id
https://gateway.snowpal.com/pod-tasks/:id/assign
https://gateway.snowpal.com/pod-tasks/:id/unassign
https://gateway.snowpal.com/pods/:id/tasks/reorder
https://gateway.snowpal.com/keys/:id/blocks
https://gateway.snowpal.com/keys/:id/blocks
https://gateway.snowpal.com/pods/:id/linked-to/blocks
https://gateway.snowpal.com/keys/:id/blocks/by-template
https://gateway.snowpal.com/keys/:id/blocks/:block-id/link
https://gateway.snowpal.com/keys/:id/blocks/:block-id/unlink
https://gateway.snowpal.com/keys/:id/blocks/available-to-link
https://gateway.snowpal.com/blocks/:id
https://gateway.snowpal.com/blocks/:id
https://gateway.snowpal.com/blocks/:id/block-types/:block-type-id
https://gateway.snowpal.com/blocks/:id/block-types
https://gateway.snowpal.com/blocks/:id/scales/:scale-id
https://gateway.snowpal.com/blocks/:id/scales
https://gateway.snowpal.com/blocks/:id/scale-value
https://gateway.snowpal.com/blocks/:id/description
https://gateway.snowpal.com/blocks/:id/archive
https://gateway.snowpal.com/blocks/:id/unarchive
https://gateway.snowpal.com/blocks/archived
https://gateway.snowpal.com/blocks/archive
https://gateway.snowpal.com/blocks/:id/allow-archival
https://gateway.snowpal.com/blocks/:id/copy
https://gateway.snowpal.com/blocks/:id/move
https://gateway.snowpal.com/blocks/:id/attachments
https://gateway.snowpal.com/blocks/:id/attachments
https://gateway.snowpal.com/block-attachments/:id/rename
https://gateway.snowpal.com/block-attachments/:id
https://gateway.snowpal.com/charts/keys/:id/blocks/:block-id/linked-resources
https://gateway.snowpal.com/charts/keys/:id/blocks/:block-id/scales/:scale-id/grades
https://gateway.snowpal.com/charts/keys/:id/blocks/:block-id/task-status
https://gateway.snowpal.com/blocks/:id/students/all/grades
https://gateway.snowpal.com/blocks/:id/checklists
https://gateway.snowpal.com/blocks/:id/checklists
https://gateway.snowpal.com/blocks/:id/checklists/reorder
https://gateway.snowpal.com/blocks/:id/checklists/:checklist-id
https://gateway.snowpal.com/blocks/:id/checklists/:checklist-id
https://gateway.snowpal.com/blocks/:id/checklists/:checklist-id/checklist-items
https://gateway.snowpal.com/blocks/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/blocks/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/blocks/:id/checklists/:checklist-id/checklist-items/reorder
https://gateway.snowpal.com/blocks/:id/comments
https://gateway.snowpal.com/blocks/:id/comments
https://gateway.snowpal.com/block-comments/:id
https://gateway.snowpal.com/block-comments/:id
https://gateway.snowpal.com/blocks/:id/notes
https://gateway.snowpal.com/blocks/:id/notes
https://gateway.snowpal.com/block-notes/:id
https://gateway.snowpal.com/block-notes/:id
https://gateway.snowpal.com/blocks/:id/tasks
https://gateway.snowpal.com/blocks/:id/tasks
https://gateway.snowpal.com/block-tasks/:id
https://gateway.snowpal.com/block-tasks/:id
https://gateway.snowpal.com/block-tasks/:id/assign
https://gateway.snowpal.com/block-tasks/:id/unassign
https://gateway.snowpal.com/blocks/:id/tasks/reorder
https://gateway.snowpal.com/blocks/:id/pods
https://gateway.snowpal.com/blocks/:id/pods
https://gateway.snowpal.com/blocks/:id/pods/by-template
https://gateway.snowpal.com/blocks/:id/pods/:pod-id/link
https://gateway.snowpal.com/blocks/:id/pods/:pod-id/unlink
https://gateway.snowpal.com/block-pods/:id
https://gateway.snowpal.com/block-pods/:id
https://gateway.snowpal.com/block-pods/:id/by-completion-status
https://gateway.snowpal.com/block-pods/:id/pod-types/:pod-type-id
https://gateway.snowpal.com/block-pods/:id/pod-types
https://gateway.snowpal.com/block-pods/:id/scales/:scale-id
https://gateway.snowpal.com/block-pods/:id/scales
https://gateway.snowpal.com/block-pods/:id/scale-value
https://gateway.snowpal.com/block-pods/:id/archive
https://gateway.snowpal.com/block-pods/archived
https://gateway.snowpal.com/blocks/:id/pods/available-to-link
https://gateway.snowpal.com/block-pods/:id/unarchive
https://gateway.snowpal.com/block-pods/archive
https://gateway.snowpal.com/block-pods/:id/description
https://gateway.snowpal.com/block-pods/:id/allow-archival
https://gateway.snowpal.com/block-pods/:id/copy
https://gateway.snowpal.com/block-pods/:id/move
https://gateway.snowpal.com/block-pods/:id/attachments
https://gateway.snowpal.com/block-pods/:id/attachments
https://gateway.snowpal.com/block-pod-attachments/:id/rename
https://gateway.snowpal.com/block-pod-attachments/:id
https://gateway.snowpal.com/charts/block-pods/:id/tasks
https://gateway.snowpal.com/charts/classroom-pods/:id/students/grades
https://gateway.snowpal.com/block-pods/:id/checklists
https://gateway.snowpal.com/block-pods/:id/checklists
https://gateway.snowpal.com/block-pods/:id/checklists/reorder
https://gateway.snowpal.com/block-pods/:id/checklists/:checklist-id
https://gateway.snowpal.com/block-pods/:id/checklists/:checklist-id
https://gateway.snowpal.com/block-pods/:id/checklists/:checklist-id/checklist-items
https://gateway.snowpal.com/block-pods/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/block-pods/:id/checklists/:checklist-id/checklist-items/:checklist-item-id
https://gateway.snowpal.com/block-pods/:id/checklists/:checklist-id/checklist-items/reorder
https://gateway.snowpal.com/block-pods/:id/comments
https://gateway.snowpal.com/block-pods/:id/comments
https://gateway.snowpal.com/block-pod-comments/:id
https://gateway.snowpal.com/block-pod-comments/:id
https://gateway.snowpal.com/block-pods/:id/notes
https://gateway.snowpal.com/block-pods/:id/notes
https://gateway.snowpal.com/block-pod-notes/:id
https://gateway.snowpal.com/block-pod-notes/:id
https://gateway.snowpal.com/block-pods/:id/tasks
https://gateway.snowpal.com/block-pods/:id/tasks
https://gateway.snowpal.com/block-pod-tasks/:id
https://gateway.snowpal.com/block-pod-tasks/:id
https://gateway.snowpal.com/block-pod-tasks/:id/assign
https://gateway.snowpal.com/block-pod-tasks/:id/unassign
https://gateway.snowpal.com/block-pods/:id/tasks/reorder
https://gateway.snowpal.com/blocks/:id/acl
https://gateway.snowpal.com/blocks/:id/users/:user-id/acl
https://gateway.snowpal.com/blocks/:id/users/:user-id/unshare
https://gateway.snowpal.com/blocks/:id/users/:user-id/share
https://gateway.snowpal.com/blocks/:id/users/:user-id/share/with/pods
https://gateway.snowpal.com/search/blocks/:id/shareable/users
https://gateway.snowpal.com/blocks/users/:id/share
https://gateway.snowpal.com/blocks/:id/leave
https://gateway.snowpal.com/block-pods/:id/acl
https://gateway.snowpal.com/block-pods/:id/users/:user-id/share
https://gateway.snowpal.com/block-pods/:id/users/:user-id/unshare
https://gateway.snowpal.com/block-pods/users/:id/share
https://gateway.snowpal.com/search/block-pods/:id/shareable/users
https://gateway.snowpal.com/block-pods/:id/users/:user-id/acl
https://gateway.snowpal.com/block-pods/:id/leave
https://gateway.snowpal.com/pods/:id/acl
https://gateway.snowpal.com/pods/:id/users/:user-id/share
https://gateway.snowpal.com/pods/users/:id/share
https://gateway.snowpal.com/pods/:id/users/:user-id/unshare
https://gateway.snowpal.com/search/pods/:id/shareable/users
https://gateway.snowpal.com/pods/:id/users/:user-id/acl
https://gateway.snowpal.com/pods/:id/leave
https://gateway.snowpal.com/blocks/:id/project-pods
https://gateway.snowpal.com/blocks/:id/project-pods/by-template
https://gateway.snowpal.com/blocks/:id/project-pods/:pod-id/link
https://gateway.snowpal.com/blocks/:id/project-pods/reorder
https://gateway.snowpal.com/project-pods/:id/copy
https://gateway.snowpal.com/project-pods/:id/move
https://gateway.snowpal.com/project-pods/:id/assign
https://gateway.snowpal.com/project-pods/:id/unassign
https://gateway.snowpal.com/blocks/:id/project-block-lists
https://gateway.snowpal.com/blocks/:id/project-block-lists
https://gateway.snowpal.com/project-block-lists/:id/pods/copy-all
https://gateway.snowpal.com/project-block-lists/:id/pods/copy
https://gateway.snowpal.com/project-block-lists/:id/pods/move-all
https://gateway.snowpal.com/project-block-lists/:id/pods/move
https://gateway.snowpal.com/blocks/:id/project-block-lists/:list-id/move
https://gateway.snowpal.com/blocks/:id/project-block-lists/:list-id
https://gateway.snowpal.com/blocks/:id/project-block-lists/:list-id
https://gateway.snowpal.com/blocks/:id/project-block-lists/reorder
https://gateway.snowpal.com/blocks/:id/project-block-lists/:list-id/archive
https://gateway.snowpal.com/classroom-pods/:id/submissions/attachments/as-student
https://gateway.snowpal.com/classroom-pods/:id/submissions/comments/as-student
https://gateway.snowpal.com/classroom-blocks/:id/students
https://gateway.snowpal.com/classroom-pods/:id/submissions/attachments/as-teacher
https://gateway.snowpal.com/classroom-pods/:id/submissions/comments/as-teacher
https://gateway.snowpal.com/classroom-pods/:id/attachments/as-teacher
https://gateway.snowpal.com/classroom-pods/:id/comments/as-teacher
https://gateway.snowpal.com/classroom-blocks/:id/student-grades/as-teacher
https://gateway.snowpal.com/classroom-blocks/:id/student-grades/publish
https://gateway.snowpal.com/classroom-pods/students/:id/grades/publish
https://gateway.snowpal.com/classroom-pods/:id/students/grades/publish
https://gateway.snowpal.com/classroom-blocks/:id/students/grades
https://gateway.snowpal.com/classroom-pods/:id/students/grades
https://gateway.snowpal.com/classroom-blocks/:id/student/grade
https://gateway.snowpal.com/classroom-pods/:id/student/grade
https://gateway.snowpal.com/classroom/students/:id/profile
https://gateway.snowpal.com/app/resource/attributes
https://gateway.snowpal.com/keys/:id/attributes
https://gateway.snowpal.com/blocks/:id/attributes
https://gateway.snowpal.com/pods/:id/attributes
https://gateway.snowpal.com/block-pods/:id/attributes
https://gateway.snowpal.com/block-types
https://gateway.snowpal.com/block-types
https://gateway.snowpal.com/block-types/:id
https://gateway.snowpal.com/block-types/:id
https://gateway.snowpal.com/block-types/:id/blocks
https://gateway.snowpal.com/comments/recent
https://gateway.snowpal.com/conversations/unread-status
https://gateway.snowpal.com/conversations
https://gateway.snowpal.com/conversations
https://gateway.snowpal.com/conversations/by-usernames
https://gateway.snowpal.com/conversations/:id/messages
https://gateway.snowpal.com/conversations/:id
https://gateway.snowpal.com/conversations/:id
https://gateway.snowpal.com/conversations/:id/leave
https://gateway.snowpal.com/conversations/:id/archive
https://gateway.snowpal.com/favorites
https://gateway.snowpal.com/favorites/keys/:id
https://gateway.snowpal.com/favorites/blocks/:id
https://gateway.snowpal.com/favorites/pods/:id
https://gateway.snowpal.com/favorites/block-pods/:id
https://gateway.snowpal.com/favorites/:id
https://gateway.snowpal.com/app/users/follow-us
https://gateway.snowpal.com/app/followers
https://gateway.snowpal.com/notifications
https://gateway.snowpal.com/notifications/unread
https://gateway.snowpal.com/notifications/unread/count
https://gateway.snowpal.com/notifications/:id/read
https://gateway.snowpal.com/notifications/read
https://gateway.snowpal.com/pod-types
https://gateway.snowpal.com/pod-types
https://gateway.snowpal.com/pod-types/:id
https://gateway.snowpal.com/pod-types/:id
https://gateway.snowpal.com/pod-types/:id/pods
https://gateway.snowpal.com/profiles
https://gateway.snowpal.com/profiles
https://gateway.snowpal.com/profiles/username/:id
https://gateway.snowpal.com/users/:id/block
https://gateway.snowpal.com/users/:id/unblock
https://gateway.snowpal.com/app/users/sign-up
https://gateway.snowpal.com/app/users/sign-in
https://gateway.snowpal.com/app/users/reset-password
https://gateway.snowpal.com/app/user-verified/:id
https://gateway.snowpal.com/search/relations
https://gateway.snowpal.com/keys/:id/relations
https://gateway.snowpal.com/blocks/:id/relations
https://gateway.snowpal.com/pods/:id/relations
https://gateway.snowpal.com/block-pods/:id/relations
https://gateway.snowpal.com/keys/:id/keys/:target-key-id/relate
https://gateway.snowpal.com/keys/:id/keys/:target-key-id/unrelate
https://gateway.snowpal.com/keys/:id/blocks/:target-block-id/relate
https://gateway.snowpal.com/keys/:id/blocks/:target-block-id/unrelate
https://gateway.snowpal.com/keys/:id/pods/:target-pod-id/relate
https://gateway.snowpal.com/keys/:id/pods/:target-pod-id/unrelate
https://gateway.snowpal.com/blocks/:id/pods/:target-pod-id/relate
https://gateway.snowpal.com/blocks/:id/pods/:target-pod-id/unrelate
https://gateway.snowpal.com/blocks/:id/blocks/:target-block-id/relate
https://gateway.snowpal.com/blocks/:id/blocks/:target-block-id/unrelate
https://gateway.snowpal.com/pods/:id/pods/:target-pod-id/relate
https://gateway.snowpal.com/pods/:id/pods/:target-pod-id/unrelate
https://gateway.snowpal.com/scales
https://gateway.snowpal.com/scales
https://gateway.snowpal.com/scales/:id
https://gateway.snowpal.com/scales/:id
https://gateway.snowpal.com/scales/:id
https://gateway.snowpal.com/scales/:id/blocks
https://gateway.snowpal.com/scales/:id/pods
https://gateway.snowpal.com/scheduler/all-events
https://gateway.snowpal.com/scheduler/all-events/by-start-date
https://gateway.snowpal.com/scheduler/standalone-events
https://gateway.snowpal.com/scheduler/standalone-events
https://gateway.snowpal.com/scheduler/standalone-events/:id
https://gateway.snowpal.com/scheduler/standalone-events/:id
https://gateway.snowpal.com/search
https://gateway.snowpal.com/search/users
https://gateway.snowpal.com/templates/keys
https://gateway.snowpal.com/templates/blocks
https://gateway.snowpal.com/templates/pods
https://gateway.snowpal.com/users
https://gateway.snowpal.com/users/uuid/:id
https://gateway.snowpal.com/users/email/:id
https://gateway.snowpal.com/users/deactivate-account
https://gateway.snowpal.com/users/delete-account
https://gateway.snowpal.com/app/latest-version
https://gateway.snowpal.com/app/status

Private & Group Conversations: Implement In-App Conversations in Quick Time

Varun Palaniappan — Thu, 14 Mar 2024 00:07:20 GMT

Get API Key

This podcast discusses Snowpal Conversation API and its features. It highlights the benefits of using the API instead of building conversation functionality from scratch. The conversation API is designed for products and applications that require conversation as a feature, such as messaging apps. The API supports basic conversation functionality, including private and group conversations, archiving, leaving, and deleting conversations. The implementation experience is seamless, and the API can be easily integrated into web and mobile applications. Snowpal offers various pricing options, including subscriptions, licenses, and professional services.

Takeaways

The Conversation API simplifies the implementation of conversation functionality in web and mobile applications.
The Conversation API supports basic conversation features such as private and group conversations, archiving, leaving, and deleting conversations.
Integration with the Conversation API is seamless, and it can be easily consumed by developers.

Chapters

00:00 Introduction to the Conversation API

01:24 Using Existing Conversation Platforms

02:04 Features of the Conversation API

03:10 Summary of Features

05:19 Implementation Experience

06:10 Integration and Pricing Options

08:10 Benefits for Different Organizations

Video

Transcript

Conversation API: Adding the ability to support in-app conversations just got a whole lot easier

24.7KB ∙ PDF file

Download

Summary

Overview of Conversation API

Krish introduces the topic and sets the context for discussing the Conversation API offered by Snowpal.
He mentions the simplicity of the API and its relevance for integrating conversation functionality into web or mobile applications.

Explanation of Conversation Features

Krish elaborates on the features of the Conversation API, such as private conversations, group conversations, archiving, leaving groups, deleting conversations, read receipts, etc.
He provides examples of how these features work and emphasizes their importance for integrating conversation functionality into applications.

Technical Details and Endpoints

Krish discusses the technical aspects of the Conversation API, including the number of endpoints, their functionalities, and how they can be utilized in application development.
He highlights the ease of implementation once the API endpoints are integrated into the application.

Considerations for API Integration

Krish talks about the challenges and considerations involved in integrating APIs, such as handling permutations, combinations, nuances, and edge cases.
He emphasizes the importance of simplifying functionality without overloading endpoints or proliferating them.

Licensing and Pricing Models

Krish explains the different licensing and pricing models available for the API, including subscription-based, annual, request-based, and licensing options.
He mentions customization options for larger clients and the flexibility in choosing a suitable licensing model based on the organization’s needs.

Onboarding and Support Services

Krish mentions professional services offered by Snowpal, including onboarding assistance and support for clients who require additional help with integration or implementation.
He highlights the self-service nature of the API integration process, allowing development teams to handle it independently.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Status Management API: Build Slack Apps, Microservices and more

Varun Palaniappan — Wed, 13 Mar 2024 23:11:55 GMT

Get API Key

In this video, Krish introduces the Snowpal Status Management API and its purpose. He explains that the API is designed to manage statuses for projects and provides an interface for users to report their status. Krish discusses the features and functionality of the API, including the ability to report status as a user or admin. He also explains the components of a status, such as plan for today, sessions, and blocked by. Krish highlights the details and attributes that can be added to a status, and mentions the integration and licensing options available for the API. The podcast concludes with a summary of the API and resources for further information.

Takeaways

The Snowpal Status API is designed to manage statuses for projects and provides an interface for users to report their status.
The API supports reporting status as a user or admin, allowing for flexibility in how statuses are updated.
A status consists of components such as plan for today, sessions, and blocked by, which provide a structured format for reporting status.
The API offers various details and attributes that can be added to a status, including tickets, sessions, and custom attributes.
Integration and licensing options are available, including SAS-based models, cloud provisioning, and licensing for DevOps and platform engineering infrastructure.

Chapters

00:00 Introduction to Snowpal Status API

02:42 Features and Functionality of the Status API

03:42 Reporting Status as a User or Admin

05:08 Components of a Status

09:00 Details and Attributes of a Status

10:39 Integration and Licensing Options

12:15 Conclusion

Video

Transcript

Snowpal Status Management API: Build Slack Apps, Microservices and more

29.8KB ∙ PDF file

Download

Summary

Status API Details

Explanation of the status API and its purpose.
Mention of other APIs and their related podcasts.
Explanation of the absence of a user interface for the status API.
Information on accessing the API through Postman collection and product API documentation.

API Features and Functionality

Purpose of the status API for managing statuses in projects.
Details on reporting statuses as a user or team member.
Features and functionalities supported by the API.
- Reporting status for today’s plan.
- Sessions and managing multiple sessions.
- Adding tickets and other items to sessions.
- Blocked by category for tracking obstacles.

Technical Details and Customization

Attributes and details associated with tickets.
Mention of custom attributes and extending functionalities.
Overview of SDK availability.
Details on accessing the API, licensing models, and integration options.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Access Control API: Custom Permissioning (Privileges, Roles, Members, Teams)

Varun Palaniappan — Wed, 13 Mar 2024 22:08:54 GMT

Get API Key

This video provides an overview of Snowpal Access Control List (ACL) API and explains how it can be used to manage access control in a web application. The API allows users to create privileges and roles, associate them with teams and members, and grant access to resources. The conversation covers the implementation steps for integrating the ACL API, including creating teams and members, granting access, and checking access at runtime. The video also discusses licensing and integration options for using the ACL API.

Takeaways

The ACL API provides a comprehensive solution for managing access control in web applications.
Users can create privileges and roles, associate them with teams and members, and grant access to resources.
Integrating the ACL API can save time and effort in implementing access control functionality.
The API supports a range of integration options, including SaaS model and licensing for on-premises deployment.

Chapters

00:00 Introduction to the Access Control List API

01:18 Overview of the Project Management App

02:13 Using the Access Control List API for Web App Implementation

03:09 Creating Privileges and Roles

04:01 Understanding Roles and Privileges

05:12 Associating Privileges with Roles

06:19 Implementing Access Control in the Web App

09:25 Integration Steps for Access Control API

10:35 Creating Teams and Members

12:21 Granting Access to Teams and Members

14:25 Creating Resources and Granting Access

16:41 Fetching Privileges and Roles for Resources

18:48 Checking Access at Runtime

21:34 Licensing and Integration Options

23:17 Conclusion and Next Steps

Video

Transcript

Access Control API: Custom Permissioning (Privileges, Roles, Members, Teams)

43.2KB ∙ PDF file

Download

Summary

Introduction and Overview

Krish introduces the video and discusses the focus on the Access Control List (ACL) API.
Mention of saving time, effort, and money by integrating the API.
Emphasis on allowing web, mobile, or service teams to work on core customer problems.

Demonstration of Existing App

Krish briefly shows an existing web application related to project management.
Explains the hierarchy of content and demonstrates sharing with different access levels.
Mentions the ACL model in the context of the project management app.

Access Control API Overview

Provides the URL for the Access Control List (ACL) API.
Encourages using the Postman collection for a better understanding.
Highlights the importance of having APIs available for developers to start coding quickly.

Roles and Privileges Explanation

Krish explains the concept of roles and privileges in the context of the ACL API.
Discusses creating privileges, custom privileges, and their association with roles.
Mentions the absence of roles in the current implementation but presents a theoretical role structure.

Implementation Steps for Access Control

Krish details the steps involved in integrating the Access Control API.
Steps include creating privileges, roles, teams, and members.
Explains the simplicity of the implementation for UI teams.

Members and Teams Explanation

Differentiates between members (users) and teams.
Describes how teams can be created and associated with roles or privileges.
Emphasizes the flexibility of the implementation.

Granting Access to Resources

Discusses the process of granting access to resources using privileges or roles.
Explains the hierarchy and complexity in assigning access levels.
Highlights the importance of leaving backend complexities to the provided APIs.

Integration Steps and Use Cases

Krish summarizes the integration steps for UI teams.
Emphasizes the flexibility of the API for different use cases.
Encourages teams to focus on solving specific business problems rather than backend complexities.

Closing and Call to Action

Krish concludes the video, inviting questions and expressing willingness to help.
Promotes the use of Snowpal’s Access Control API through different models (SaaS or licensing).
Stresses the goal of providing more time to focus on core business problems.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Classroom API: Build Apps and Microservices for the Education Industry

Varun Palaniappan — Wed, 13 Mar 2024 20:02:35 GMT

Get API Key

This video provides an overview of Snowpal Classroom API and its value proposition. It explores the use of the API in a web application and showcases its features and functionality. The episode also covers collaboration, custom grading scales, student functionality, and performance tracking. It highlights the availability of documentation and SDKs for developers and discusses licensing and deployment options. The episode concludes by discussing different partnership models for using the Classroom API.

Takeaways

The episode provides a comprehensive overview of the Snowpal Classroom API.
Explores how the API can be integrated into web applications, highlighting its functionality in this context.
Showcases various features of the Classroom API, including collaboration tools, custom grading scales, student functionality, and performance tracking.
Points out the availability of documentation and SDKs, indicating support for developers looking to implement the Classroom API.
Discusses licensing options, providing insights into how users can deploy and utilize the API effectively.

Chapters

00:00 Introduction to Snowpal Classroom API

01:15 Using the Classroom API in a Web Application

03:10 Features and Functionality of the Classroom API

05:43 Overview of the Classroom API

06:09 Collaboration and Custom Grading Scales

08:05 Student Functionality and Performance Tracking

09:06 Accessing Documentation and SDKs

10:36 Licensing and Deployment Options

11:41 Choosing the Right Partnership Model

Video

Transcript

Classroom API: Build Apps and Microservices for the Education Industry

29.3KB ∙ PDF file

Download

Summary

Snowpal’s API Suite

Overview of the suite of APIs offered by Snowpal.
Emphasis on the intention to explore each API in detail through videos.
Value proposition and benefits of integrating the API rather than building from scratch.

Demonstration of Classroom API

Practical demonstration of using the Classroom API in a web application.
Creating courses, assignments, grading scales, and interacting with students.

Use Cases and Scenarios

Illustration of how the API can be used by teachers and students in various scenarios.
Highlighting features such as assessments, collaboration, and messaging.

API Functionalities

Overview of specific functionalities provided by the Classroom API.
Mention of capabilities such as custom grading scales, publishing grades, and comparing performances.

API Documentation and Subscription

Information on where to find documentation for the API.
Steps to subscribe to the API, obtain API keys, and choose payment options.

SDKs and Integration

Availability of SDKs in Golang and plans for expanding to other languages.
Information on how to integrate the API into different platforms.

Licensing and Collaboration Options

Explanation of various licensing and collaboration options, including AWS Marketplace and infrastructure choices.

Conclusion and Next Steps

Recap of key points about the Classroom API.
Encouragement for users to explore and integrate the API for their specific needs.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Snowpal API: Licensing Models

Varun Palaniappan — Fri, 08 Mar 2024 00:13:07 GMT

Get API Key

Part 1/2

This video discusses the pricing and licensing models available for integrating Snowpal APIs. The speaker emphasizes that there are multiple options to cater to different client needs. The chapters cover various pricing models, including pay per request, monthly or annual plans, usage-based plans, connecting to the client's database, provisioning in the client's cloud infrastructure, and private offers. Each option is explained in detail, highlighting the steps and considerations involved.

Takeaways

Snowpal offers a range of pricing and licensing models to cater to different client needs.
Clients can explore the pricing models on the Snowpal API documentation website.
Options include pay per request, monthly or annual plans, usage-based plans, connecting to the client's database, provisioning in the client's cloud infrastructure, and private offers.
Clients have the flexibility to choose the model that best suits their requirements and budget.

Chapters

00:00 Introduction and Overview

00:57 Exploring Pricing Models

03:04 Option 1: AWS Marketplace

04:26 Option 2: Pay per Request

05:50 Option 3: Pay Monthly or Annually

07:17 Option 4: Pay Monthly or Annually + Usage

10:11 Option 5: Connecting to Client's Database

12:11 Option 6: Provisioning in Client's Cloud Infrastructure

14:31 Option 7: Client's Infrastructure

17:22 Option 8: Private Offer

Video

Transcript

Snowpal API: Licensing Models (Part 1/2)

34.7KB ∙ PDF file

Download

Summary

Introduction and Overview

Krish introduces the topic and mentions the flexibility in licensing models.
Factors influencing the choice of licensing, such as the client’s project size, immediate needs, and budget.

Documentation and Starting Points

Krish directs users to explore pricing models through API documentation on developers.snowpal.com and product information on products.snowpal.com.
Emphasis on multiple options for accessing documentation.

Pricing Models Overview

Discussion on different licensing and pricing models available for Snowpal APIs.
Krish emphasizes the diversity of options to cater to different client needs.

Pay per Request

Krish explains the simplicity of paying per request, suitable for MVPs and prototyping.
Details the process of subscribing through AWS Marketplace and receiving an API key.

Pay Monthly or Annually

Introduces the option to pay a fixed amount monthly or annually.
Emphasizes the flexibility of plans and suggests annual payments for cost savings.

Monthly or Annual Plan with Usage Charges

Describes a plan where clients pay a fixed amount but can incur additional charges for exceeding allocated requests.
Mentioned as a variation of the monthly or annual payment model.

Connecting to Client’s Database

Offers a solution for clients who want their data to reside in their database but still utilize Snowpal APIs.
Specifies the need for write access to the client’s database.

Provisioning in Client’s Cloud Infrastructure

Allows clients to run Snowpal services in their own cloud infrastructure.
Mention of seamless integration for AWS and slight provisioning effort for other cloud providers.

Clients’ Infrastructure

Clients handle the entire setup, including licensing, implementation, and management.
No direct involvement of Snowpal in infrastructure handling.

Private Offer

Introduces the concept of a private offer for clients with unique requirements.
Customized solutions outside of standard pricing models.

Conclusion

Krish concludes the discussion on licensing options.

Part 2/2

In this video, Krish discusses the licensing options for Snowpal APIs. He recaps the seven different options available, including pay-per-request, subscription-based, and custom options. Krish explains that these options are designed to cater to companies of all sizes and stages. He highlights the importance of choosing the right licensing option based on the company's specific needs and goals. Krish also mentions that in subsequent videos, he will explore how to use the APIs independently and collectively.

Takeaways

Snowpal offers seven different licensing options for their APIs, including pay-per-request, subscription-based, and custom options.
The licensing options are designed to cater to companies of all sizes and stages, from solopreneurs to established businesses.
Choosing the right licensing option depends on the company's specific needs and goals.
In subsequent videos, Krish will discuss how to use the APIs independently and collectively.

Chapters

00:00 Introduction and Recap

02:23 Reasons for Different Licensing Options

03:20 Use Cases for Different Licensing Options

05:10 Adapting to Changing Technologies

06:05 Next Steps and Conclusion

Video

Transcript

Snowpal API: Licensing Models (Part 2/2)

21.4KB ∙ PDF file

Download

Summary

Licensing Options Overview:

Krish discusses the seven licensing options available for Snowpal APIs.
Options include pay-per-request, subscription models, overages, using own databases, cloud infrastructure, purchasing a license, and creating a private offer.
Emphasis on flexibility based on the user’s company size and needs.

Explanation of Use Cases:

Krish provides scenarios for different types of users: solopreneurs, startups with funding, companies building new applications, those leveraging APIs to reduce time to market, and larger organizations looking to expand services.
Emphasis on using Snowpal APIs for quick development, scalability, and extensibility.
Highlighting the value of leveraging APIs in the context of evolving technologies and changing approaches.

Closing and Future Topics:

Krish concludes by summarizing the use cases and encouraging users to explore the options.
Teases future videos on using the APIs independently and collectively.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Classroom API: Integrate Snowpal APIs to build apps and microservices for the education industry

Varun Palaniappan — Thu, 07 Mar 2024 22:34:34 GMT

Get API Key

This video showcases the functionality of the Snowpal API for building software solutions in the education industry. It demonstrates how to create courses, assessments, and manage grades using the API. The video also discusses the implementation of backend functionality and the various licensing and deployment options available. Additionally, it highlights the flexibility of the API to be customized for different industries.

Takeaways

The Snowpal API provides a quick and efficient way to build software solutions for the education industry.
The API allows for the creation of courses, assessments, and the management of grades.
Backend functionality can be implemented easily using the API, saving time and effort.
The API offers various licensing and deployment options, including integration with AWS.

Chapters

00:00 Introduction and Overview

01:26 Building Software Solutions for the Education Industry

04:46 Managing Grades and Grading Scales

06:26 Publishing Grades and Comparing Performance

09:23 Implementing Backend Functionality

11:18 Licensing and Deployment Options

12:32 Customizing for Different Industries

14:02 Conclusion

Video

Transcript

Classroom API: Integrate Snowpal APIs to build apps and microservices for the education industry

30.7KB ∙ PDF file

Download

Summary

Introduction and Purpose:

Krish introduces the video and its purpose.
Discusses the idea of showcasing functionality to help build apps quickly using Snowpal APIs.

Demonstration - Teacher Functionality:

Krish demonstrates using the Snowpal application for managing projects and introduces the teacher-related functionalities.
Creates test data, adds courses, assigns grading scales, and sets up quizzes.

Student Interaction:

Discusses the perspective of a student interacting with the platform.
Assigns grades to students, discusses the grading scales, and the publishing of grades.

API Overview and Usage:

Krish discusses the backend implementation and API functionalities.
Highlights the availability of documentation and endpoints for building educational systems.

Publishing Grades and Student Comparison:

Krish explains how grades are published and shows how to compare student performance.

Reflection on Functionality:

Reflects on the implemented functionality and its real-world applicability.
Discusses the effort involved in implementing such features without leveraging Snowpal APIs.

Licensing and Infrastructure Options:

Krish explains various licensing models and infrastructure options for using Snowpal APIs.

Conclusion and Next Steps:

Krish concludes the video, summarizes key points, and encourages viewers to explore Snowpal APIs.

Additional Information:

Mentions AWS Marketplace, cloud platforms (AWS, Azure, Google Cloud), and professional services.

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Relations API Endpoints: Connecting disparate resources

Varun Palaniappan — Thu, 07 Mar 2024 20:42:37 GMT

Get API Key

In this video, Krish introduces a feature called Relations and explains how it can save time, money, and mitigate risks for developers who are looking for ways to connect disparate resource in a system. He demonstrates the functionality of the web app and shows how users can connect and navigate between different pieces of content. Krish also highlights the flexibility of using Relations with Snowpal APIs and how it can be customized for various industries. By leveraging Snowpal APIs, developers can save time and effort in implementing complex functionality and focus on building their own unique solutions.

Summary

Introduction:

Krish introduces the feature called Relations (00:01.162).
Demonstrates the functionality on the Project Management platform, particularly on the web app (00:49.267).

Benefits of API Integration:

Emphasizes how leveraging Snowpal APIs can save time, money, and mitigate risks for developers (01:19.123).
Encourages developers to use stable, scalable, and extensible APIs instead of reinventing the wheel (01:47.963).

Overview of Relations Feature:

Explains that Relations is about connecting disparate pieces of content for easier navigation (02:25.160).
Highlights the functionality of relating different content pieces for users to maneuver quickly (02:51.005).

Demonstration Using Web App:

Provides a live demonstration on the web app, creating content blocks for courses (03:51.010).
Shows how a teacher can connect and navigate between different courses using the Relations feature (05:55.504).

Bi-Directional Connections:

Explains the bi-directional nature of relations, where if A is connected to B, then B is connected to A (07:58.158).
Demonstrates how to establish and remove connections between content pieces (09:42.126).

API Implementation:

Introduces the concept of using APIs for Relations functionality (09:42.126).
Discusses various API endpoints for handling relations, including relating keys to blocks and blocks to pods (09:42.126).

Flexibility and Customization:

Emphasizes the flexibility of the Relations feature for different industries and use cases (12:11.792).
Encourages developers to map the functionality to their specific requirements when integrating with Snowpal APIs (12:11.792).

Time and Effort Savings:

Stresses the time saved by leveraging pre-built APIs instead of implementing them from scratch (12:11.792).
Positions Snowpal’s approach as saving time, money, and effort for developers (12:11.792).

Conclusion:

Encourages viewers to consider integrating Snowpal APIs for their projects and expresses confidence in the benefits (12:11.792).
Highlights the potential for developers to be happy with the time and effort saved through API integration (12:11.792).

Takeaways

Functionality in Web App: Krish demonstrates how the Relations feature works within a web app, showcasing how users can connect and navigate between different pieces of content.
Flexibility with Snowpal APIs: The video emphasizes the flexibility of using Relations Endpoints in Snowpal APIs. It suggests that developers can customize and implement this feature for various industries according to their specific needs.

Chapters

00:00 Introduction to the Feature

01:30 Understanding Relations

09:30 Using Relations with APIs

12:11 Benefits of Leveraging Snowpal APIs

Video

Transcript

Relations API: Connecting disparate resources

29.5KB ∙ PDF file

Download

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Integrate Building Blocks API to Reduce Time to Market

Varun Palaniappan — Thu, 07 Mar 2024 00:50:20 GMT

Get API Key

This video discusses the process of integrating Snowpal APIs into a new or existing application. It explores the benefits of leveraging APIs to reduce time to market and improve efficiency. The video emphasizes the importance of understanding requirements and working closely with product teams. It also highlights the need to avoid reinventing the wheel by utilizing existing backend systems and mapping terminologies and functionalities. The video concludes by offering assistance and professional services for API integration.

Takeaways

API integration can significantly reduce development time and improve efficiency.
Understanding requirements and working closely with product teams is crucial for successful integration.
Avoid reinventing the wheel by leveraging existing backend systems and mapping terminologies and functionalities.
Professional services are available to assist with API integration.

Chapters

00:00 Introduction and Background

02:19 API Integration

03:49 Understanding Requirements

04:13 Design Phase

05:16 Front-end and Back-end Changes

06:16 Front-end Development

08:05 Backend Development

09:01 Leveraging Existing Backend Systems

09:30 Avoiding Reinventing the Wheel

10:28 Mapping Terminologies

12:11 Functionality Mapping

15:26 Implementation

16:32 Seeking Help and Conclusion

Video

Transcript

Snowpal API Integration: Use Building Blocks API to Reduce Time to Market

35.6KB ∙ PDF file

Download

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Snowpal Backend as a Service: API Product Suite

Varun Palaniappan — Wed, 06 Mar 2024 22:20:52 GMT

Get API Key

This video provides an introduction to Snowpal APIs and an overview of their API suite. It explains the different documentation formats available and emphasizes the APIs as building blocks for developers. The video then dives into the details of each API, including Building Blocks, Project Management, Content Management, Classroom, Conversation, Status, Custom Attribution, and Access Control. It concludes by discussing the licensing and implementation options and highlighting the extensive documentation and resources available for developers.

Takeaways

Snowpal offers a suite of APIs that serve as building blocks for developers to quickly build applications without reinventing the wheel.
The APIs cover various functionalities such as project management, content management, classroom management, conversations, status updates, custom attribution, and access control.
Snowpal provides different documentation formats, including Postman collections and developer documentation, to cater to the needs of both development and product teams.
Developers can choose from multiple licensing and implementation options, including subscription-based licensing and integrating the APIs into their own infrastructure.

Chapters

00:00 Introduction to Snowpal APIs

02:00 Overview of Snowpal API Suite

03:28 Different Documentation Formats

04:33 APIs as Building Blocks

05:29 Building Blocks API

07:12 Project Management API

08:31 Content Management API

10:06 Classroom API

10:52 Conversation API

11:59 Status API

13:06 Custom Attribution API

14:06 Access Control API

17:19 Licensing and Implementation

19:49 Extensive Documentation and Resources

Video

Transcript

Snowpal Backend as a Service: API Product Suite

39KB ∙ PDF file

Download

On Other Platforms

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

APIs as Building Blocks: Advantages of integrating time tested APIs

Varun Palaniappan — Tue, 05 Mar 2024 21:56:19 GMT

Get API Key

This video provides an overview of the Building Blocks API offered by Snowpal. The API serves as foundational building blocks for developers to build various applications. The video covers the documentation, benefits, pricing options, and a real-life example of an app built using the API. It also emphasizes the importance of understanding terminologies and mapping them to business problems. The different endpoints, such as dashboard, keys, and blocks, are explored. The video concludes by highlighting the flexibility of the API for customization and its potential for various industries.

Takeaways

The Building Blocks API by Snowpal provides foundational building blocks for developers to build applications.
The API documentation includes various endpoints and is available in both Postman and developer documentation formats.
Using the Building Blocks API reduces development time and allows developers to focus on specific business problems.
The API can be customized and mapped to specific industries and use cases.

Chapters

00:00 Introduction to Building Blocks API

01:27 Overview of Building Blocks API Documentation

02:23 Benefits of Using Building Blocks API

03:22 Example of Using Building Blocks API

05:20 Subscription and Pricing Options

06:18 Real-Life Example of an App Built with Building Blocks API

07:20 Understanding Terminologies and Mapping to Business Problems

08:47 Exploring Endpoints: Dashboard, Keys, and Blocks

11:40 API Documentation Layout

14:26 Using Building Blocks API for Specific Industries

17:19 Customizing Endpoints for Specific Use Cases

18:18 Recap and Conclusion

Video

Transcript

Benefits of using Snowpal's Building Blocks API

35.3KB ∙ PDF file

Download

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Testing APIs on Postman: A quick look at some features offered by Postman

Krish Palaniappan — Tue, 05 Mar 2024 07:56:26 GMT

Get API Key

The speaker discusses the increasing use of Postman over Insomnia for API Gateway work, citing uncertainty regarding loyalty shifts due to Postman's GraphQL support. They express interest in exploring Postman's features, including its workspace on postman.snowpal.com. While acknowledging Postman's strengths in testing endpoints and managing environment variables, they raise concerns about limitations such as the inability to tie responses between requests and the risk of vendor lock-in. Emphasizing the importance of considering team skill sets and needs, they advocate for managing dependencies in separate repositories. Finally, they highlight version control challenges and urge caution against using tools for short-term convenience that may lead to long-term issues, concluding with a call to explore Snowpal's products and subdomains.

Summary

Introduction to Postman and Insomnia:

Mention of increased usage of Postman in API Gateway work.
Uncertainty about shifting loyalties from Insomnia to Postman due to GraphQL support.

Exploring Postman Features:

Mention of Postman workspace on postman.snowpal.com.
Interest in exploring features previously not utilized.

Testing Endpoints with Postman:

Description of features for testing endpoints in Postman.
Mention of using JavaScript code for pre-requests and post-requests.

Environment Variables in Postman:

Discussion on managing environment variables in Postman.
Importance of having separate environments for different users and scenarios.

Challenges and Limitations of Postman:

Lack of support observed for tying responses of one request to another.
Concerns about vendor lock-in and inability to externalize code.

Decision Making and Best Practices:

Considerations for team skill sets and needs in choosing tools.
Preference for managing dependencies in separate repositories.

Conclusion:

Mention of version control challenges and doubts about Postman’s suitability for large-scale projects.
Caution against using tools for short-term convenience that may lead to long-term issues.

Podcast

Transcript

0:02

Hey there. As part of the current work that we’re doing, the API Gateway work, we’ve begun to use Postman a whole lot more than we have in the past. I’m not sure if we have shifted loyalties from Insomnia to Postman. I wouldn’t say that yet because I don’t know how well Postman supports GraphQL. We love Insomnia for a lot of other things, including its GraphQL support, but I’ve seen that they know, given that we published Postman, the Postman workspace on postman.snowpal.com for instance.

0:26

You can go check out our workspace there. We’ve begun to use that quite a bit, right? And we’ve tried to learn more of its features, features that we didn’t necessarily care for all along, which may or may not make a difference at this point. But there’s that. There’s one that caught my attention. I see other teams using it and I want to know, just want to share my thoughts on whether, in my opinion, whether it’s a good idea or not such a good idea doing it right.

0:48

I don’t know if I have a strong opinion. We’ll see as the video progresses. So let’s say we have, we have a number we all of our endpoints are broken down into different directories in the collection in our very first API, the one that we just went live with, and you can go to developers.snowpal.com to check that out.

1:06

Postman supports a number of these features to test your endpoints, right? So you can add some code like JavaScript code for instance. I don’t know if they support other languages too, but you can add JavaScript code that’s embedded like snippets into these endpoints and then they have pre-requests and post-requests.

1:21

What happens before you run a request? What happens after you run a request? And there are ways for you to create like test suite so you can run all the endpoints, all the test, all the endpoints in your collection, in your collection or in your directories, maybe under. I don’t know if they supported at the directory level, but I’m pretty sure they do and probably also at the collection level, right?

1:38

So those are convenient, but the thing here is right. I don’t I maybe they have support for it. I haven’t seen it carefully enough. But you have these values and your values come from these environment variables and you have multiple environments and you can have any number of them right? Not just by your but whether it’s by dev, test, aging abroad.

1:55

You can also have it by developer, you can have it by the user you’re going to be testing. You know, let’s say Chris is testing API user one against this and on this environment I can have an environment specifically for that. If somebody else is testing that same user on a different environment on the same one, they could have a different environment and have, you know, overwritten values for it, right?

2:18

So we do it all the time. That way you don’t run into each other, you know, interfering with other developers environments, and then you may have a global environment, but you’re not really touching anything else. You don’t want to be touching or impacting other people. That is fine, but those values are hard coded. I don’t know if Postman has any support.

2:34

I haven’t seen one where you can tie the response of one request to the other. Maybe they have a way to do that. If they do, let me know, right? And let’s see how. I mean, I would like to know how good it is and how graceful it is. If it is there, then it is going to be pretty powerful that that actually solves a part of the problem that was going to talk here right now that I think about it, but I don’t know if they do and if they do, to what extent, right?

2:59

But if whether they do or don’t, even if you made those decisions, you actually wrote the code, the snippets within Postman. The challenge there is you’re kind of married to the tool, right? Sort of to the vendor. And it’s not easy to externalize that and put it in a repo. Now if everybody’s just using Postman, your team and your testing team is exclusively using it and your developers are using it all the time.

3:19

That might not be a bad decision to make, but I still think of him. We don’t ask no problem. We don’t believe in vendor lock in. We use AWS, we use Google, Google Cloud, we use lots of languages, lots of stacks, we have polyglot. So we don’t like to be tied to or married to any one thing. Our interests abroad, the problems we solve are pretty broad as well.

3:38

So in that sense, if you want, if you wanted to at some point write it in different languages and externalize it outside postman, you wouldn’t be able to do that. That is a downside of using all the support a particular tool gives you. But on the flip side, you might argue that I don’t want to maintain another repo.

3:54

Maybe my team doesn’t write as much code at least this part of the team that’s doing all this testing so I’d rather do it on Postman. In that case I think you might still be you might be all right and and doing that kind of stuff so so make a decision based on what what your team skill sets are and what your what your needs essentially are.

4:14

We’ve sort of we lean on the side of creating our own repos to managing and maintaining our dependencies. So we do use Postman for some part of a testing, but something that’s quick and dirty, right? But some any part of our testing that needs that needs to be repetitive.

4:31

We most certainly do that in our own test repos and sort of manage and maintain it exclusively over there. And again, we the we use different languages for doing that as well. But you could just pick one, whatever it is, whether it’s Go or Ruby or Node or C# or Java, it doesn’t matter.

4:47

Whatever your team’s preferred languages, and you can build it on that. That way you’re not sort of. You don’t have these code snippets all over the place in Postman and and you’re going beyond that. There’s more issues that I can think of as I as I’m talking, right? How do you version control this?

5:04

I don’t know if Postman supports something like that, right? So maybe you have to create multiple collections, and if you did, maybe the code snippets you wrote on one one collection, maybe they don’t carry over to the other. So do you? Do you have a new collection, new version for every change that you make? What?

5:20

Let’s say we have 400 endpoints. How do we make changes to these endpoints? And if we’re not changing the definition of the endpoint, but just the code that runs around it, how do we version control that? So maybe now that I think about it, maybe this won’t even work on Postman. I mean, we didn’t even think it would, so we never bothered to spend even a day trying to figure that out.

5:39

It didn’t look like it would do it. And sometimes, a lot of times, you trust your hunch, having done this for a long time. But if all of this is possible, if all of this can gracefully actually be done on Postman, then it’s actually a much better tool than I think it is. I think it’s a good tool, but I don’t think…

5:55

I think sometimes I’ve seen people use it for things that are kind of convenient in the short term, but maybe you’re going to shoot yourself in the foot in the long term. So definitely be wary of that kind of stuff, right? That’s about it. Talk to you soon again. Go to developers.snowpal.com, learn.snowpal.com, snowpal.com.

6:12

There are plenty of our subdomains. Each of them is a different product, different client, mobile, web, API, and whatnot. But do check all of it out or some of it out. It’d be very much appreciated.

Thank you.

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Go SDK and Go Recipes for Snowpal APIs

Krish Palaniappan — Tue, 05 Mar 2024 07:52:09 GMT

Get API Key

The speaker discusses the addition of recipes to the SDK repository, categorizing them into business and engineering recipes to cater to different developer needs. There's an explanation of the SDK's dual purpose of providing functionality for integration and serving as a learning resource. The strategy of developing recipes across multiple programming languages is outlined, emphasizing both duplication and uniqueness across languages. The podcast concludes with a summary of the discussion and an encouragement for users to sign up and integrate with the API.

Summary

Introduction and Overview

Opening greetings and introduction to the podcast topic.

Current Go SDK Work

Mention of ongoing work on the Go SDK and its objectives.
Explanation of adding recipes to the SDK repository.

Types of Recipes

Introduction of two categories of recipes: business recipes and engineering recipes.
Explanation of the content and purpose of each recipe type.

Structure and Functionality

Discussion on structuring the SDK to serve multiple purposes.
Explanation of the coexistence of SDK functionality and recipe content in the same repository.
Future plans to expand recipes into other programming languages.

Recipe Development Strategy

Discussion on duplicating recipes across different languages.
Explanation of the value of unique recipes for different languages.
Overview of the current progress and tasks involved in developing recipes.

Podcast

Transcript

0:01

Hey there, hope you’re doing well. In this podcast, I want to talk a little bit about the current Go SDK work that we are doing. I did mention that in one of the previous podcasts, and I’m going to continue. I don’t know where I left off, but I’m just going to pick up from where I think I left off in the last one of the last podcasts.

0:19

So, I mentioned that we have a number of endpoints we’re trying. We’re adding this first Go SDK on our first API that we published and went live on a week ago. So definitely check out developers.snowpal.com as part of the SDK. While the primary objective of that repo is publishing and creating the Go SDK, we are also intending to and beginning to actually add recipes to that same repository. So recipe could mean a few different things, but just for terminology, just to make sure we are on the same page.

0:57

Here is what we think of the recipes. A recipe is something that we’re going to publish, and as a developer, when you look at a recipe, there could be two categories of recipes, right? One is, we’re going to call it a business recipe, and the other one is like an engineering recipe. The difference between the two is that a business recipe speaks more about solving business problems, probably contract use cases because we don’t exactly know what your use cases are since our API is going to be able to cater to a wide variety of use cases and it’s very industry agnostic as well.

1:28

So we are going to come up with a set of use cases, some simple enough ones, and maybe have more complex ones as we progress. Those are business recipes. The engineering recipes would be not so business-oriented. It could be essentially if you took up something like Postman and you took a workspace and you took a collection and we have a number of directories where we have categorized our endpoints.

1:51

Each of that directory, let’s say there’s a directory that deals exclusively with key attachments, right? So that would be like different thread operations and attachments and functionality on key attachments, not key or block or pod attachments, for example, because we don’t support attachments on keys directly. Those would be, we are going to call them engineering recipes because collectively they don’t really solve a very specific business problem because they are not intending to, at least by way of the example, they’re trying to showcase the actual functionality of the endpoints more from a development standpoint.

2:24

So we’re going to call them engineering recipes. So if you’re a developer who wants to get a quick sense of how a certain endpoint works or a certain group of endpoints work or a certain directory works, the way we’ve categorized them on Postman or one of the other clients, whatever your favorite REST client is, you could start with an engineering recipe or look at them first. But if you’re a product owner or product manager, the business recipe might resonate better with you. Sure, both parties are welcome to look at both categories of recipes. That’s our ultimate goal. But your starting point could actually be different based on where you’re coming from, what your particular role is. So we’re going to add those recipes to the same repo.

3:04

So when we are structuring the SDK and developing, building it, we are cognizant of the fact that it needs to serve two purposes, right? One is the purpose that I have mentioned, which is essentially being an SDK. So you can start importing snowpile, the snowpile SDK into your Go repository and your Go applications and start leveraging our API. But also, at the same time, if you want to just learn and understand, get a breather, get a feel for the scope of what we’ve done and for the functionality it actually truly provides, then the recipes would actually be a better fit. Right now these recipes, given that they’re going to be living alongside the Go SDK, the initial recipes would be written in Go, but as we create more SDKs in other languages like Node or C# or whatever else, our aim is to actually build recipes for those as well.

4:58

Now, whether we’re going to build the exact same recipes from an SDK standpoint, it needs to be exactly the same. Other than the fact that the language is different, your SDK, its functionality and its versions and its dependencies are going to be quite identical. But from a recipe standpoint, not necessarily so, right? So when we have a set of recipes on this Go sitting parallel to the Go SDK, and we build like say a Ruby or a TypeScript SDK, we may have different recipes because the idea behind the recipes is that they collectively showcase our functionality uniquely to you and to help you get started, hit the ground running quickly, right?

6:27

That’s basically it. And hopefully, it gives you some sense of how, you know, once you publish an API, what are sort of the more natural next steps, right? SDK was a very natural next step. The recipe was also a next step, but we are trying to figure out which one to do first and then we identified that maybe we can actually do them together if we took this approach. And that’s what I want to share with you. Hope that helped. And definitely, you know, sign up on snowpal.com if you’re an end-user. If you’re a company, your software company building cool applications no matter what they are, definitely check out our API and start integrating with us. Yep, thanks. Talk to you soon.

Snowpal Products

Backends as Services on AWS Marketplace
Mobile Apps on App Store and Play Store
Web App
Education Platform for Learners and Course Creators

Write a Golang app to parse Postman Collection to return API Endpoint details

Krish Palaniappan — Wed, 21 Feb 2024 04:21:09 GMT

Get API Key

Whether you are an API Producer or Consumer, there’s a good chance you are using Postman API Client (given how popular it is). We are not going to discuss how to use Postman in this article as we already have a course published for it (and it costs less than $5) but what we’ll do here is take a quick look at one of the files in a repo that we at Snowpal will be shortly making public.

We needed a quick way to socialize our API Endpoints and since we have a number of APIs and 1000s of endpoints, sending Postman Collection links to our clients, though a viable option, did not scale. Sometimes, we needed to socialize just the endpoint routes and not every aspect of those endpoints.

So, we wrote a simple app in Golang to take care of this.

You can run the app by feeding it Postman Collection JSONs, filter by HTTP Verb and choose to write just the title, description, URL or all of it to a local file.

package main

import (
	"encoding/json"
	"fmt"
	"os"
	"postman/lib"
)

func main() {
	postmen := make([]lib.Root, 0)
	pwd, _ := os.Getwd()
	for _, file := range postmanSpecifications() {
		dat, _ := os.ReadFile(pwd + "/spec/" + file)
		postman := lib.Root{}
		if err := json.Unmarshal(dat, &postman); err != nil {
			panic(err)
		}

		postmen = append(postmen, postman)
	}

	fo, err := os.Create(pwd + "/spec.md")
	if err != nil {
		panic(err)
	}

	// close fo on exit and check for its returned error
	defer func() {
		if err := fo.Close(); err != nil {
			panic(err)
		}
	}()

	endpointTitles := make([]string, 0)
	total := 0
	options := lib.Options{
		SkipDuplicates:     true,
		IncludeDescription: false,
		WriteTitles:        false,
		WriteUrls:          true,
	}
	for _, postman := range postmen {
		println(fmt.Sprintf("Writing endpoints for %s", postman.Info.Name))
		postman.WriteEndpoints(
                   []string{}, postman.Info.Name, "", &total, fo,
			&endpointTitles, options)
		println("Done \n")
	}
}

func postmanSpecifications() []string {
	return []string{
		"postman_building-blocks-api.json",
		"postman_content-management-api.json",
		"postman_project-management-api.json",
		"postman_conversation-api.json",
		"postman_classroom-api.json",
		"postman_go-status-api.json",
		"postman_custom-attribution-api.json",
		"postman_access-control-list-api.json",
	}
}

When you run the above app, it will produce the result below (in this case, we chose to write the URLs, for example).

# Snowpal: Building Blocks API 
## (1) Dashboard.1.1: Get dashboard details (https://gateway.snowpal.com/dashboard/combined-responses) 
## (2) Dashboard.1.2: Get recently modified blocks and pods (https://gateway.snowpal.com/dashboard/recently-modified) 
## (3) Dashboard.1.3: Get unread count (https://gateway.snowpal.com/dashboard/unread-count) 
## (4) Dashboard.1.4: Get recently modified keys (https://gateway.snowpal.com/dashboard/recently-modified/keys) 
## (5) Dashboard.1.5: Get pods and tasks due shortly (https://gateway.snowpal.com/dashboard/due-shortly/pods-and-tasks) 
## (6) Dashboard.1.6: Get blocks due shortly (https://gateway.snowpal.com/dashboard/due-shortly/blocks) 
## (7) Dashboard.1.7: Get unread notifications (https://gateway.snowpal.com/dashboard/notifications/unread-status) 
## (8) Dashboard.1.8: Get unread conversations (https://gateway.snowpal.com/dashboard/conversations/unread-status) 
...

Now, this makes it much simpler to have a chat with a prospect and touch upon some of the endpoints to prove the value proposition of our APIs.

Snowpal Products

Access Control List API: Share your content with other users by granting them granular access that is customizable

Krish Palaniappan — Mon, 19 Feb 2024 19:39:57 GMT

Get API Key

Access Control needs vary for each app. Sure, there may be similarities between some of the requirements but what tends to make things sometimes more complex than they really need to be are the nuances. The devil is in the detail, as they say.

Let’s take a look at a practical implementation of an app in production and delve into its access control model.

In the screenshot above, a resource (1040, as we near the tax season!) is shared with 2 users, Raj and Jerry. Raj has Write access while Jerry has Admin access. There are 3 possible access levels:

Read: user can view but make no modifications
Write: user can make changes but cannot grant access to other users
Admin: user has all privileges

If you asked your UI Developer to implement a React Page to support the requirements above, it would be pretty straightforward to them from a UI implementation standpoint. All they are going to ask you for are the API Endpoints that they need to call, and your API team would provide a specification with the respective endpoints as below.

If the API is already implemented and ready to go, it will make this feature as seamless as it can possibly be, and your stakeholders are bound to be pleased.

Now, let’s assume this API, and its related endpoints, are not ready. They need to be designed, implemented, tested and deployed before the UI developer can start integrating. Suddenly, things seem a lot more complicated, don’t they?

There’s 2 options available in this scenario —

Option 1: Implement the very basic that’s needed

There’s 3 levels of access (aka, privileges), no notion of roles and there is no need to support teams (as a group of users). Have your API team get started with development work and only work to satisfy your current needs.

It will still take them time but being myopic is going to be cost-effective, even if only in the short run.

The risks — well, when your needs evolve (as they surely will), this design is not going to cut it and your API team might find themselves in a pickle as they will have to go back to the drawing board, rethink, reimplement and also worry about Backward Compatibility.

Option 2: Think ahead and make the API a bit more generic

Do it the right way (even if not the perfect way, the good way). Ask questions to your product team along the lines of:

Do we need to support other privileges in future?
- If so, will be they predefined or should we also support custom privileges (ones that are not supported out of the box)?
Is there a need to support roles (a bag of privileges, that is)?
What about teams (aka, organizations) that group users?

This will take a few iterations before you can finalize requirements, and once finalized, your API team can work on implementing a more generic and extensible API.

The risk — well, it is going to take a lot longer, there’s going to plenty more testing needed given the broader set of features, your UI team may not get a drop for a while and that would mean they would have to live with stubbed out endpoints a lot longer and run the risk of bugs being found much later down the road when you get to Integration Testing.

Both these options have their pros and cons but what if there were a 3rd option that included the best of both worlds?

Well, don’t you worry because there is one!

Introducing Snowpal’s Access Control API

All our APIs have support for basic access control but to make things sweeter for our clients, we have also introduced an exclusive Access Control API.

It has everything you should need from an Access Control standpoint, and it is ready to be consumed — as of this moment! Take a look at that, and let us know if you have any questions.