- Quick Overview
- App Manager
- REST API
- API Intro
- App Authentication
- Application Data
- Custom Auth
- Custom Data
- Events Intro
- Event Add
- Event Get
- Event Update
- Event Comment Add
- Event Comment Delete
- Event Comments Get
- Event Comment Update
- Event Participant Invite
- Event Participants Invite
- Event Participants Get
- Event Participant Delete
- Event Request Invitation
- Event RSVP
- Events Search
- Events Search by Person ID
- Event AppData Add
- Event AppData Delete
- Event AppData Get
- Event AppData Get All
- Event AppData Update
Getting up and running with Proxomo is extremely easy. Here is a high level look at the main steps you need to understand to get your app using Proxomo.
1. Register your app with the App Manager
- When you register your new app through the App Manager, Proxomo generates two important values for your app: Application ID and Proxomo API Key. These values are unique for each app and are necessary for authentication for your app to communicate with Proxomo. Therefore, don't share these values or reuse them with other apps.
If you want to integrate your app with Facebook or you just want to give users the option to log into your app with their Facebook login then complete the following steps (for more background info refer to User Management and Facebook Auth):
- Create a Facebook app. Facebook will generate two unique values for your app: Facebook Application ID and Application Secret
- Copy these two unique Facebook values over to the Proxomo App Manager registration for your app
Congratulations. You are ready to run in Proxomo! Let's see how to make some calls!
2. Get an Authentication Token for your App
You are now ready to write code to communicate with Proxomo. Every time your app calls into Proxomo, Proxomo must distinguish your app from all the other apps that call into Proxomo. To accomplish this, your app must first call App Authentication call into Proxomo and pass in the two unique values that the App Manager assigned to your app: Application ID and Proxomo API Key.
In exchange, Proxomo returns to you a unique Authentication Token value that your app can then use for all subsequent calls into Proxomo. For security reasons, this token expires in 30 days after being issued. Once expired, your app needs to get a new token by again making the call to App Authentication.
3. Access all other Proxomo methods
Now you have the basis that will allow you to access most of the remaining Proxomo functionality . Since the specificsmay differ differ from platform to platform, here is what we recommend:
- Get started with one of the SDKs and samples that we provide (Windows Phone, IOs or .NET). You can also communicate directly with the Proxomo REST API. You can find documentation on every endpoint (and method) under the REST API documentation section.
- Make sure to select the platform that you will be developing in from the drop down menu located towards the top right of all our documentation pages . That way we will display all infomation that is relevant to your platform.
What to read next?
Once you have completed the steps above, consider reading about our User Management feature. It will help you manage your users: from how they log into your app to how you create and manage their user settings.