Glue Up API

Introduction

This is the Glue Up open API v2 document, it includes 5 business collections:

• User Collection
• Event Collection
• Subscription Collection
• Membership Collection
• Finance Collection

Click on any API, you can easily try out with your specific parameters.

API Request Structure

URI

From Apiary console, we try out APIs on apidemo server. Note that in your integration code, please use the corresponding live server where your organization is on, with the public / private key we provided. Please do not test in Apiary with the keys of live server, otherwise unexpected errors will occur.

• API integration server URI:

  • https://api-demo-story.glueup.com/v2/

• Live server URI:

  • https://api-services.glueup.cn/v2/
  • https://api-services.glueup.com/v2/
  • https://api.glueup.ru/v2/

Header

Here is an example of an API request header.

a: v=1.0;k=springfield_demo;ts=1382312423124;d=213213
token: WnComsVP_DTky7RUXWhwhDYSdcFfCeSv2UiFIAbqP0V1uuILmESL_0l6WVQqVWyamArQWz5IHOeo9UsSr9PV1I1SOrnPuoqU42Ul_EYFe2z12MzZIDlWjQ3H1TuLdujI

Parameters - a

a is a required parameter in header for each API

• v: 1.0 (client version)
• k: springfield_demo (public key, change for the API account)
• ts: 1382312423124 (timestamp of now)
• d: 213213 (digest, a calculated string with following parameters)
  • publicKey: springfield_demo (change for the proper API account)
  • privateKey: MFwCAQACEADDpHP6QMQ9YDFqr/3N9EsCAwEAAQIPeUcOpglUHO5v5ZnRBu1RAggP+NdjEftxPQIIDD/CPCfRxCcCB3R7VlQt0JUCCAQQSvIGC9NVAggJiEGjTIKpjg== (change for the API account)
  • requestMethod: GET / POST / PUT / DELETE (change for different API)
  • version: 1.0 (client version)
  • time: 1382312423124 (timestamp of now)

Here is a sample code of generating parameter d (digest) in Java.

import org.joda.time.DateTime;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Hex;

public class Helper {
    public static String getDigest(String publicKey, String privateKey, String requestMethod, String version) {
        String result = null;
        String ALGORITHM = "HmacSHA256";
        long time = DateTime.now(DateTimeZone.UTC).getMillis();
        StringBuffer baseString = new StringBuffer(requestMethod);
        baseString.append(publicKey);
        baseString.append(version);
        baseString.append(nowAsDateTime().getMillis());
        SecretKeySpec signingKey = new SecretKeySpec(privateKey.getBytes(), ALGORITHM);
    
        try {
            Mac mac = Mac.getInstance(ALGORITHM);
            mac.init(signingKey);
            result = Hex.encodeHexString(mac.doFinal(baseString.toString().getBytes()));
        }
        catch ( Exception e ) {
            log.error("Exception in getDigest()", e);
            throw new RuntimeException(e);
        }
        return result;
    }
}

Parameters - token

• token is a user session token returned by user login action, it's required by user related APIs.

Body

Here is an example of a JSON-format body of an API request.

{
    "projection": [],
    "offset": 0, 
    "limit": 5,
    "order": {
        "startDateTime": "desc", 
        "title": "asc"
    },
    "filter": [
        {
            "projection":"name",
            "operator":"eq",
            "values": ["GlueUp"]
        }
    ],
    "search": {
        "fields":["givenName","familyName","emailAddress"],
        "value":"Test",
        "fullText":true
    },
    "order": {
        "startDateTime": "asc"
    },
    "language": {
        "code": "en"
    }
}

Pagination

• Provide the offset and limit in order to retrieve a limited amount of items.

Order

• Let you order the requested list using the properties available.
• You can add more properties to order with more criteria.
• Specify the order by using either ASC or DESC.

Filter

• Let you filter the requested list using the properties available.
• For each filters, you need to specify a valid projection, the wanted operator and the values as an array.

Search

• Let you search the requested list using the properties available.

List of available operators

API Response Structure

Body

Here is an example of a JSON-format return of an API request. We will review each property and how to use them.

{
    "code": 200, 
    "data": {
        "value": [
            "..."
        ], 
        "errors": [
            {
                "code": -1000, 
                "messages": [
                    "Invalid email format."
                ]
            }
        ], 
        "warnings": [
            {
                "code": -2001, 
                "messages": [
                    "[collaboratorCategories] is not a projectable property"
                ]
            }
        ], 
        "metadata": {
            "pagination": {
                "total": 15
            }
        }
    }
}

Code

• The code is the HTTP status code from the request.
• It is use to provide a description on the result of the request.

Common used HTTP Status Codes:

Value

• "value" contains the content requested.

Errors

• If you receive “errors”, it indicate a failure.
• It will contain an error code and a message to describe the problem.

Warnings

• If you receive “warnings”, it denotes a side-effect caused by the service that could potentially alter user experience, but it is not an indication of failure.
• It will contain an error code and a message to describe the problem.

Metadata

• It contains the pagination count to know the total number of items for this specific request.

Model Formats

Event Model

Notes : The event model contains more properties that are used in the administration section.
If you need details on other properties and/or miss an important one, please contact us.

Sample Code:

{
    "id": 937, 
    "language": {
        "code": "en"
    }, 
    "defaultLanguage": {
        "code": "en"
    }, 
    "title": "Test Edit default Ticket", 
    "startDateTime": 1453345200000, 
    "endDateTime": 1459418400000, 
    "venueInfo": {
        "id": 937, 
        "venueReusable": false, 
        "zoom": 14, 
        "name": "Soho", 
        "city": [ ], 
        "cityName": "Bengaluru", 
        "country": {
            "code": "IN", 
            "name": "India"
        }, 
        "latitude": 12.9731, 
        "longitude": 77.592385
    }, 
    "eventRole": {
        "code": "ORGNZ", 
        "name": "Lead Organizer"
    }, 
    "published": true
}

// Java
LocalDateTime startDateTimeLocal = 
    ZonedDateTime.ofInstant(
    Instant.ofEpochMilli(startDateTime),
    ZoneId.ofOffset("UTC", 
        ZoneOffset.ofHours(8))
    ).toLocalDateTime();
        

Location Model

The Location Model is used to describe an address such as the event venue.

"venueInfo": {
    "name": "EB Office", 
    "streetAddress": "Guanghua Lu SOHO", 
    "cityName": "Beijing", 
    "province": "Beijing", 
    "zipCode": "10000", 
    "country": {
        "code": "CN", 
        "name": "China"
    }, 
    "info": "Add."
}

Membership Company Model

If you need details on other properties and/or miss an important one, please contact us.

{
    "featured": true,
    "membershipId": 78,
    "startDate" : 1482487597000, 
    "adminContact":{
        "givenName" : "John",
        "familyName" : "Doe",
        "emailAddress": {
            "value": "john.doe@glueup.com"
        }
    }
    "id": 21323,
    "industryCode": "INVEST",
    "address": {
      "streetAddress": "Guang Hua Lu",
      "cityName": "Beijing",
      "province": "Beijing",
      "zipCode": "100000",
      "country": {
        "code": "CN"
      }
    },
    "phone": {
      "value": "+86 13456789000"
    },
    "groups": {
      "value": {
        "value": "event"
      }
    },
    "image": {
      "filename": "64e2a82e-8ec0-4417-a584-b3d02f541383.png",
      "id": "64e2a82e-8ec0-4417-a584-b3d02f541383",
      "uri": "/resources/public/images/square/::size::/64e2a82e-8ec0-4417-a584-b3d02f541383.png"
    },
    "name": "GlueUp",
    "fax": {
      "value": "+86 13456789000"
    },
    "companyWebsiteAddress": "www.glueup.com",
    "members": [
      {
        "id": 22183,
        "phone": {
          "value": "+86 13456789000"
        },
        "givenName": "John",
        "familyName": "Doe",
        "positionTitle": "Engineer",
        "image": {
          "filename": "64e2a82e-8ec0-4417-a584-b3d02f541383.png",
          "id": "64e2a82e-8ec0-4417-a584-b3d02f541383",
          "uri": "/resources/public/images/square/::size::/64e2a82e-8ec0-4417-a584-b3d02f541383.png"
        }
      }
    ]
}

Membership Member Model

If you need details on other properties and/or miss an important one, please contact us.

{   
    "membership" : {
        "id" : 78,
        "startDate" : 1482487597000, 
        "featured": true,
        "membershipType":{
            "id": 56,
            "title": Entrepreneurs,
            "type": People
        } 
    },
    "individualMember" : {
        "id": 132,
        "membershipId": 78,
        "image": {
              "filename": "64e2a82e-8ec0-4417-a584-b3d02f541383.png",
              "id": "64e2a82e-8ec0-4417-a584-b3d02f541383",
              "uri": "/resources/public/images/square/::size::/64e2a82e-8ec0-4417-a584-b3d02f541383.png"
            },
        "givenName" : "John",
        "familyName" : "Doe",
        "companyName" : "Eventbank",
        "postionTitle" : "Developer",
        "industry": {
              "code": "CONSLT"
        },
        "address": {
            "streetAddress": "Guang Hua Lu",
            "cityName": "Beijing",
            "province": "Beijing",
            "zipCode": "100000",
            "country": {
                "code": "CN"
            }
         },
        "emailAddress": {
            "value": "john.doe@glueup.com"
        },
        "phone": {
            "value": "+86 15201516676"
        },
    }
}

Membership Member Model include two model, Membership Model and IndividualMember Model.

• Membership Model

• IndividualMember Model

Membership Type Model

Sample Code:

{
    "id": 702,
    "organizationId": 2040,
    "title": "Membership Type Name eg.",
    "internalTitle": "Internal Membership Type Name eg.",
    "type": "People",
    "description": "<p>Membership Description eg.</p>",
    "status": "Active",
    "approvalRequired": true,
    "renewalApprovalRequired": true,
    "renewalConfirmRequired": true,
    "memberApprovalRequired": false,
    "activationRequired": true,
    "index": 4,
    "defaultLanguageCode": "en",
    "languageCode": "en",
    "renewalCreationPeriod": 30,
    "gracePeriod": 30,
    "gracePeriodEnabled": true,
    "showInDirectory": true,
    "createdOn": 1572257697000,
    "lastModified": 1572257992000,
    "activeVersions": [ ... ],
    "public": true
}

• Membership Type Version Model

Sample Code:

{
    "organizationId": 2040,
    "membershipTypeId": 702,
    "version": 1,
    "status": "Current",
    "duration": 12,
    "memberLimit": 0,
    "defaultCurrencyCode": "CNY",
    "free": false,
    "additionalMembersAllowed": false,
    "additionalMembersFree": true,
    "additionalMembersLimit": 0,
    "extraMembersPriceEnabled": false,
    "newTermFixedDate": true,
    "newTermFixedDay": 1,
    "newTermFixedMonth": "JANUARY",
    "proRataEnabled": true,
    "proRataStartFrom": "JANUARY",
    "proRataTermSection": "Month",
    "proRataPriceRounding": "Current",
    "crossTermEnabled": true,
    "crossTermPeriod": 30,
    "crossTermExcludeCurrentPrice": true,
    "createdOn": 1572257697000,
    "lastModified": 1572257992000,
    "prices": [ ... ],
    "taxes": [ ... ],
    "invoice": { ... },
    "extraFee": { ... },
    "discount": { ... },
    "additionalMembersPrices": [ ... ],
    "extraMembersPrices": [ ... ]
}

• Membership Type Chapter Price Model

The price property only exists if chapter price type is Fixed.

Sample Code:

{
  "price": {
    "currency": {
      "code": "USD"
    },
    "value": 100
  },
  "chapterId": 2660
}

• Membership Type Chapter Price Rule Model

This model only for volume and graduated chapter price type, See Membership Type Chapter Price Model for fixed price info.

Sample Code:

{
  "price": {
    "currency": {
      "code": "USD"
    },
    "value": 100
  },
  "minChapterCount": 1,
  "maxChapterCount": 1
}

• Membership Type Tax Model

Sample Code:

{
    "membershipTypeId": 371,
    "membershipTypeVersion": 1,
    "internalName": "Test",
    "title": "Test",
    "internalTitle": "Test",
    "percentage": 22,
    "applyToAll": true,
    "publicName": "Test",
    "organizationId": 141,
    "id": 26
}

• Membership Type Invoice Model

Sample Code:

{
    "isInvoiceApplicantCharged": true,
    "isBTInvoiceEnabled": false,
    "btInvoiceChargePercentage": 0.00,
    "isVATGeneralInvoiceEnabled": true,
    "vatGeneralInvoiceChargePercentage": 1.00,
    "vatGeneralInvoiceMinimumAmount": 2.00,
    "isVATSpecialInvoiceEnabled": true,
    "vatSpecialInvoiceChargePercentage": 3.00,
    "vatSpecialInvoiceMinimumAmount": 4.00
}

• Price Model

Sample Code:

{
    "id": 2107,
    "currency": "CNY",
    "price": 33.00
}

• Membership Type Charge Model

Sample Code:

{
    "application": { ... },
    "renewal": { ... }
}

• Membership Type Charge Details Model

Sample Code:

{
    "percentage": 0.02,
    "prices": [ ... ],
    "proRataEnabled": false
}

Person Model

The Person model is used when you have a person type of information, like a user, a contact etc…

"publicContact": {
    "givenName": "David", 
    "familyName": "Milo", 
    "phoneNumbers": [
        {
            "value": "+86 18612341234"
        }
    ], 
    "emailAddresses": [
        {
            "value": "david.milosevic@glueup.com"
        }
    ]
}

Reference Data Model

The Reference Data model is used to retrieve a list of a specific property options in a specific language.
For example you can request the list of options for “eventType” in Chinese.

"value": [
    {
        "code": "en", 
        "name": "English"
    }, 
    {
        "code": "zh", 
        "name": "中文"
    }
]