Guide

Example Implementation

• You can utilize any REST API utility for making calls to our API
• Here is one implementation that leverages Google Appscript to get the data into the Googlesheet
• Library that orchestrates the calls to Neelix endpoints (feel free to fork)
• Example Googlesheet with embedded Appscript
• Supporting Toaster library for UI notifications

Get Started

• Pre-requisites
  You should already be signed up as a user in Neelix.IO
• You should already be a member of a space in Neelix.IO, or be added as a developer to an entity that is sponsoring space(s)

Access Permissions Model

• Option 1 : A token created for a given subscription entity by a "Maintenance" member of that entity
• grants access to any records belonging to any space sponsored by that subscription entity, and would be able to create new experiences for all of those same spaces.
• Option 2 : A token created by a "Developer" member of the subscription entity
• the access is more restrictive
• token created by a "Developer" for a given subscription entity would only have access to the specific subset of sponsored spaces that have been explicitly added to their "allowed" by a "Maintenance" user of the subscription entity.

Adding Developers to Existing Space Subscription - click on this shortcut, or

• Click "gear" icon button in the top level toolbar, and choose "Settings"
• Expand the panel with your name and click on the "Subscriptions" in the slide out panel
• Click on select "Developers" option
• Link a user as a "Developer" and specify which spaces are allowed

Create API Token - click on this shortcut, or

• Click "gear" icon button in the top level toolbar, and choose "Settings"
• Expand the "Integrations" panel and click on "API Access"
• Click on "Create New Access API Token"

Developer Helper Tool - click on this shortcut, or

• Click "gear" icon button in the top level toolbar, and choose "Settings"
• Expand the "Integrations" panel and click on "API Access"
• Click on "Helper: Query Parameters"

If you need to automate user management:

• We recommend leveraging POST "users/invite" endpoint and then checking which users authenticated with the platform via the GET "users"
• You can revoke user membership from your space via the DELETE ".../membership" as per API documentation