API Reference

Getting Started with Sarcon APIs

Explore the API documentation for effortless integration and event automation.

API Integration Guide

Authentication

HTTP Authorization Scheme: Bearer

Steps to Obtain “Client Token” for Access Token:

  1. Log in to your organiser dashboard in the backend and navigate to System APIs.
  2. Go to the Configuration tab and open it.
  3. Copy or Generate the “Client Token”.
  4. Use the given Client Token in Auth Bearer.
  5. (Refer to the following image for details.)
 

Rate Limiting

You are allowed up to 60 API requests per minute.

 

Error Handling

Error Code Message
400 Bad request format
401 Unauthorized
403 Forbidden - Authenticated user does not have access
404 Not Found - The specified resource could not be found
405 Method Not Allowed - Invalid method used
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server issue, try again later
503 Service Unavailable

Example Error Responses:

				
					{
"status": 404,
"message": "Event not found",
"data": []
}
				
			
				
					{
  "status": 400,
  "message": "",
  "data": {
    "messages": {
      "ticket_id": ["The ticket field is required."]
    }
  }
}

Pagination

Sarcon APIs use pagination to handle large amounts of data efficiently. The standard response includes:

  • current_page, first_page_url, last_page_url, next_page_url, prev_page_url, per_page, total
  • Uses links array for navigation
  • Default items per page: 20

Example Responses:

				
					{
  "status": 200,
  "message": "",
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "https://dev.sarcon.tech/api/public/v1/events?page=1",
    "last_page": 1,
    "last_page_url": "https://dev.sarcon.tech/api/public/v1/events?page=1",
    "links": [
      {"url": null, "label": "« Previous", "active": false},
      {"url": "https://dev.sarcon.tech/api/public/v1/events?page=1", "label": "1", "active": true},
      {"url": null, "label": "Next »", "active": false}
    ],
    "next_page_url": null,
    "path": "https://dev.sarcon.tech/api/public/v1/events",
    "per_page": 20,
    "prev_page_url": null,
    "total": 5
  }
}

Webhook Callbacks

Sarcon provides webhook callbacks to receive real-time HTTP POST notifications when changes occur in your events. Webhooks notify you whenever a new record is added, edited, or deleted in the following modules:

  • Registration
  • Ticket
  • Question
  • Speaker
  • Session
  • Hall
  • Contact List
  • Contact

 

How to Configure Webhooks?

  1. Navigate to System APIs > Webhook in the organiser dashboard.
  2. Enter your Callback URL where you want to receive webhook events.
  3. Select the modules you wish to subscribe to.
  4. Click Save to enable webhook notifications.

Explore APIs

Dive into the Sarcon API Universe – Unleash seamless integrations, automate workflows, and power up your events like never before.

Access the Full API Documentation and take your event tech to the next level!

Copyrights @ 2022, Sarcon.

Privacy Policy  Terms of Service