API Reference

Wiki ▸ API Reference

See one of:

• Introduction - Base URLs and some considerations when using the API
• Authentication - Sign up, log in and other authentication stuff
• Profiles - Users and Pages
• Shouts - Creating and searching shouts
• Discover - Discover and Discover Items
• Chat - Conversations and Messages
• Notifications - (APNS/GCM) push and Pusher
• Miscellaneous - Other endpoints
• Shoutit Credit - Earn and send while using Shoutit
• Other Topics - Other topics and resources

Introduction

• Base Endpoints
• Interactive Docs
• RunScope

Authentication

• Authentication Basics - Basics on how to sign up and log in Users and Pages.
• Extended Authentication - Advanced authentication topics.

Profiles

• Intro to Profiles - Profile object explanation.
• Updating Profiles - Updating and deactivating profiles.
• Listening - Listening to profiles and tags.
• Linked Accounts - Facebook, Google+, Twitter, etc

Shouts

• Intro to Shouts - Shout object explanation.
• Publishing Shouts - Creating, editing and deleting shouts.
• Searching Shouts - Getting shouts based on specified criteria.
• Filters - Info about Filters, Tags and Interests.

Discover

• Intro to Discover - What is Discover and Discover Items.
• Discover Architecture - How is Discover structured.
• Discover Item - Discover Item objects.

Chat

• Intro to Messaging - Basics about Shoutit Messaging.
• Sending Messages - Creating new Conversations and replying in existed ones.
• Extended Messaging - Reading, un-reading and deleting Messages and Conversations.
• Group Messaging - Inviting others to Conversations and promoting admins.
• Messaging Pagination - Paginating Conversations and Messages.
• Video Chat - Starting video calls using Twilio.

Notifications

• Profile Notifications - Basics about Shoutit Profile notifications.
• Native Push - APNS / GCM setup and push events.
• Pusher - Receiving real-time events by subscribing to Pusher channels.
• Pusher Channels and Events - List of channels to subscribe to and related events.

Miscellaneous

• Location - Getting, setting and geo-coding locations.
• Uploading Media - Uploading images and videos to Shoutit S3.
• Suggestions - Getting list of Users, Pages, auto-completions, etc.
• Reports - Reporting Profiles and Shouts.
• Deep Linking - Handling app links on mobile clients.

Other Topics

• Tracking actions using Mixpanel
• Answers Events - What should be sent to Fabric Answers.
• Creating APNS certificates