Share on facebook
Share on twitter
Share on email

Tech Notes – How to Integrate your App with the Club Member API

This is for advanced users who want to integrate an existing (or new) application with our Club API. The main purpose is for an application to sync data associated with members of a club with the external application. We are currently working with a club who uses a training application that needs to sync with members who have access to the training program that they signed up for in RunSignUp and pull over data that was collected during the joining process in Custom Questions.

First, you to get your partner API keys here:  https://runsignup.com/Partner/Rest/ApiKey.

Getting Club Information to Map Ids
See https://runsignup.com/API/club/:club_id/GET.

This is something you’ll probably do once after you have the club set up or after you make changes down the line.  It will let you get the ids you need to do mappings to values on your application side.

You should call https://runsignup.com/rest/club/:club_id replacing :club_id with your club id (e.g. 242).  You should make this call by setting api_key and api_secret to your partner API key.  You probably will want to use some of the include_* parameters to get the information you want.

Periodically Downloading All Current Club Members
See https://runsignup.com/API/club/:club_id/members/GET.

You should call https://runsignup.com/rest/club/:club_id/members replacing :club_id with your club id (e.g. 242).  To include question responses, add include_questions=T. You should make this call by setting api_key and api_secret to your partner API key.

Authenticating a User and Downloading Their Information
See https://runsignup.com/API/club/:club_id/members/mine/GET.

The first thing you will want to do is click “Register New Application” on https://runsignup.com/API/ApiKeys.  This will allow you to use OAuth.  You can look at https://github.com/RunSignUp-Team/OpenSource/blob/master/RunSignUpApiExamples/simpleOauthExample.php for a simple example of authenticating with OAuth.  Then, you can call https://runsignup.com/rest/user to get the user information and https://runsignup.com/rest/club/:club_id/members/mine (replacing the club id) to get the current club memberships for that user in your club.

Leave a Reply

%d bloggers like this: