APIs

1. Overview

The EventBookings API is constructed to strictly abide by the rules and the stylistic definitions of REST (Representational State Transfer), making it a REST API. Users can observe the system in the rawest and most accessible form through the usage of this API. Manipulation of the endpoints is offered with five HTTP methods (GET/POST/PUT/PATCH/DELETE), allowing the users to access EventBookings data in JSON form.

What is RESTful Web Services and REST API

REST (Representational State Transfer) is a set of constraints defining a software architectural style for constructing web services. Systems following the conventions of REST are RESTful services. The six guiding principles for any hypermedia distributed system to be a RESTful one is documented elaboratively in this link.

API Resources

The users can interact with the following resources thorough EventBookings APIs- 

  • Events
  • Orgs
  • Me
  • Reviews
  • Users
  • Common
  • Orders

Available Data Formats

Conforming to the RESTAPI principles, EventBookings API data are exchanged in JSON format. 

Authentication

EventBookings primarily uses the OAuth2.0 authentication scheme. It is a fairly recognized authentication scheme that allows the users to access information in a secured way.

Response Data 

Response data is sent as JSON, depending on the type of data requested (HTTP Content-Type header) or the type specified as being accepted (HTTP Accept header).

Retrieval methods can sometimes request PDF using application/pdf or appending .pdf to the resource URI.

Response codes are sent via the normal HTTP Response Code, and are documented separately for each resource.

For boolean fields, please note that a value of null may be considered as false. However, this is not true across all cases. Please excercise good judgement here, or contact support with any questions.

For example:

  • null can define that there’s no data available for that attribute

API - Events

API - Orgs

  • GET1. GET /orgs/{uuid}
  • POST2. POST /orgs/{uuid}
  • PATCH3. PATCH /orgs/{uuid}
  • POST4. POST /orgs/{uuid}/contact
  • POST5. POST /orgs/{uuid}/follow
  • POST6. POST /orgs/{uuid}/unfollow
  • GET7. POST /orgs/{uuid}/unfollow
  • GET8. GET /orgs/{uuid}/followed_by
  • GET9. GET /orgs/{uuid}/privacy_settings
  • PATCH10. PATCH /orgs/{uuid}/privacy_settings
  • GET11. GET /orgs/{uuid}/billing_information
  • PUT12. PUT /orgs/{uuid}/billing_information
  • GET13. GET /orgs/{uuid}/payout_information
  • PUT14. PUT /orgs/{uuid}/payout_information
  • GET15. GET /orgs/{uuid}/metrics
  • GET16. GET /orgs/{uuid}/activities
  • GET17. GET /orgs/{uuid}/events /orgs/{uuid}/events/{uuid}
  • GET18. GET /orgs/{uuid}/reviews
  • GET19. GET /orgs/{uuid}/stripe
  • POST20. POST /orgs/{uuid}/stripe/connect
  • POST21. POST /orgs/{uuid}/stripe/disconnect
  • GET22. GET /orgs/{uuid}/subscriptions
  • POST23. POST /orgs/{uuid}/subscriptions
  • POST24. POST /orgs/{uuid}/subscriptions/{uuid}/cancel
  • POST25. POST /orgs/{uuid}/subscriptions/{uuid} /reactivate
  • GET26. GET /orgs/{uuid}/team_members
  • GET27. GET /orgs/{uuid}/team_members/{uuid}
  • POST28. POST /orgs/{uuid}/team_members/{uuid} /disable
  • POST29. POST /orgs/{uuid}/team_members/{uuid} /enable
  • DELETE30. DELETE /orgs/{uuid}/team_members/{uuid}
  • GET31. GET /orgs/{uuid}/team_members/invitations
  • POST32. POST /orgs/{uuid}/team_members/invitations
  • GET33. GET /orgs/{uuid} /team_members_invitations/{uuid}
  • POST34. POST /orgs/{uuid}/team_members/invitations/ {uuid}/accept_invite
  • DELETE35. DELETE /orgs/{uuid} /team_members_invitations/{uuid}
  • DELETE36. DELETE /orgs/{uuid}/payout_information
  • POST37. POST /orgs/{uuid}/payout_information
  • POST38. POST /orgs/{uuid}/team_members /resend_invitation/{uuid}

API - Me

  • GET 1. GET /me
  • POST2. POST /me
  • POST3. POST /me/passwd
  • POST4. POST /me/receive_verification_email
  • GET5. GET /me/mutes
  • POST6. POST /me/mute
  • POST7. POST /me/unmute
  • GET8. GET /me/saves
  • GET9. GET /me/tickets
  • GET10.GET /me/tickets/{uuid}
  • GET11.GET /me/orders
  • GET12. GET /me/orders/{uuid}

API - Reviews

  • POST1. POST /reviews
  • GET2. GET /reviews/{uuid}
  • PATCH3. PATCH /reviews/{uuid}
  • DELETE4. DELETE /reviews/{uuid}
  • GET5. GET /reviews/{uuid}/likes
  • POST6. POST /reviews/{uuid}/likes
  • DELETE7. DELETE /reviews/{uuid}/likes/{uuid}
  • POST8. POST /reviews/{uuid}/reply

API - Users

  • GET1. GET /users/{uuid}
  • POST2. POST /users/{uuid}/contact
  • POST3. POST /users/{uuid}/invite_to_book
  • POST4. POST /users/{uuid}/follow
  • POST5. POST /users/{uuid}/unfollow
  • GET6. GET /users/{uuid}/follows
  • GET7. GET /users/{uuid}/followed_by
  • GET8. GET /users/{uuid}/attending
  • GET9. GET /users/{uuid}/speaking
  • GET10. GET /users/{uuid}/shares

API - Common

  • GET1. GET /common/address
  • GET2. GET /common/categories
  • GET3. GET /common/tags
  • GET4. GET /common/banners
  • POST5. POST /common/files
  • DELETE6. DELETE /common/files

API - Orders

  • GET1. GET /orders/{uuid}
    Try It Now
    Authorize
  • POST2. POST /orders
    Try It Now
    Authorize
  • PATCH3. PATCH /orders/{uuid}
    Try It Now
    Authorize
  • POST4. POST /orders/{uuid}/coupons/add
    Try It Now
    Authorize
  • POST5. POST /orders/{uuid}/coupons/remove
    Try It Now
    Authorize
  • POST6. POST /orders/{uuid}/pay
    Try It Now
    Authorize
  • POST7. POST /orders/{uuid}/cancel
    Try It Now
    Authorize
  • POST8. POST /orders/{uuid}/request_refund
    Try It Now
    Authorize
  • POST9. POST /orders/{uuid}/accept_refund
    Try It Now
    Authorize