Like Eventmaker API, Invitations REST API is implemented as vanilla JSON over HTTP using all four verbs : GET, POST, PUT and DELETE. Every resource has their own URL and is manipulated in isolation.

You can explore the view part of the API (everything that’s fetched with GET) through a regular browser. Using Firefox for this is particularly nice as it has a good, simple XML renderer. You can also get a nice view of the JSON version of the API by installing JSON View.

API Hostname

http://invitations.applidget.com

API Endpoints

If you want a summary of all the endpoints method served by Invitations, you can look at the Invitations API Overview.

Authentication

When you’re using the API, it’s always through an existing user in Invitations. There’s no special API user. So when you use the API as “john@company.org”, you get to see and work with what John is allowed to. Authenticating is done with an authentication token, which you’ll found in your user profile once you are logged in.

Then you just need to append auth_token as a query parameter of the URL. For instance, you can retrieve a JSON array of all the partners for a specific event you manage by issuing the following request:

GET /api/v1/events/{event_id}/partners.json?auth_token=YOUR_API_TOKEN

For information about how to test the API, Request and response format, API return codes and error messages, check the Eventmaker API documentation.

Integration

Once you have created a partner campaign and a partner access token for a specific partner, you can embed into your website the dashboard for this partner by using the following URL :

/embed/events/{event_id}/partners/{partner_id}/partner_campaigns/{partner_campaign_id}/set_recipients?token={partner_access_token_authentication_token}

This dashboard will allow the partner to manage their list of recipients and send emails.