Overview

The Jamatu API uses HTTP methods and a RESTful endpoint structure. The API authorization framework is OAuth 2.0. You format requests in JSON and the APIs return JSON-formatted responses.


API operations

Use the Jamatu REST APIs in these environments

Environment
Descripton
Endpoint
Test
Test. Use your test credentials to generate an access token to make calls to the Sandbox URIs.
https://test.jamatu.com
Live
Production. Use your live credentials to generate an access token to make calls to the live URIs.
https://api.jamatu.com
To construct a REST call, combine:
For example, this request get a list of your events:
    {
        "meta": {
            "success": true,
            "status_code": 200,
            "status_description": "OK",
            "error_messages": null
        },
        "data": [
        {
            "EventId": 1,
            "ExternalEventId": 0,
            "Name": "update",
            "OrganizerId": 1,
            "Organizer": "Example",
            "StartDate": "2017-05-06T13:50:00",
            "EndDate": "2017-05-11T15:55:00",
            "Location": "Zürich, Switzerland",
            "Street": "334",
            "City": "Zürich",
            "Nr": null,
            "Zip": "3434",
            "CountryId": 216,
            "Country": "Switzerland",
            "LocationRSVP": false,
            "Description": "Example description",
            "DescriptionRSVP": false,
            "CoverImg": "Image-url",
            "CoverImageBase64": null,
            "CoverImgPrefix": null,
            "CoverLandscape": true,
            "OrganizerLogo": null,
            "ContactName": null,
            "ContactEmail": null,
            "ContactPhone": null,
            "CategoryId": 5,
            "Category": "Viewing",
            "EventTypeId": 0,
            "EventType": null,
            "IsDrafted": 0,
            "Status": false,
            "Minprice": 0,
            "Maxprice": 0,
            "CreateDate": "0001-01-01T00:00:00",
            "OrganizerPhotoPath": null
        }
        ],
        "pagination": {
            "offset": 0,
            "fetch": 1,
            "next_url": "http://api.jamatu.com/next-url",
            "count": 1,
            "count_all": 100
        }
    }

Filtering and pagination

You can use query parameters to filter and page the responses to these GET requests:

For example, the pagination method returns how many rows have been returned and how many are left in total in the response:
    "pagination": {
        "offset": 0,
        "fetch": 1,
        "next_url": "http://api.jamatu.com/next-url",
        "count": 1,
        "count_all": 100
    }