Skip to main content

API

Updated over 5 months ago

Get started with the Core API

We offer an API for external systems to pull and push data from Core. To give a system API access, you will need to create a user for that system. Ultimately the API user needs to have the permission to Use Core API

Do not lock yourself out: Any user with the permission to Use Core API will not be allowed to log in using a normal interface.

Accessing the Endpoints

All of the API calls follow a similar scheme to URI below

https://ASSOCIATION_SLUG.recliquecore.com/api/v1/ <!-- Requires Basic Authentication -->

Association Slug

The slug is the unique identifier of the association inside the Core system. Typically, it's a word that identifies the association and it's the subdomain of recliquecore.com used to access the system. The easiest way to find the slug s to go to your profile by clicking on Profile on the top right corner of the Core interface.

Profile

The slug will be the letters before the numbers in the User ID. For example metropolis on the example below.

User ID

Endpoint Authentication

Core API V1 uses https Basic Authentication for accessing the endpoints.

Oauth Authentication for Members

Oauth is currently available to authenticate member accounts through Core. This would allow members to use their Core credentials as a Single Sign On (SSO) for other apps. Please contact us if this is something you are interested in.

Available Endpoints

Core API Enpoint documentation has moved to https://apidocs.recliquecore.com.

Give access to Y360

All you need to do is create a user with access to the API and share the secure credentials with YMCA360. Here are the steps:

  1. From the main menu go to All Users

  2. Click + Add User / Staff

  3. Enter information.

    • Select the api_access role or equivalent for your association

    • We recommend username y360

    • We recommend a strong random password of at least 10 characters (make a note of it so you can share with y360)

    • Makre sure the "Force Reset" is NOT checked

    • Select the homebranch and all the branches this user will have access to

  4. Click save

  5. Once the page reload make sure this user has access to 'Look Up Members'

    • Check the box for Look Up Members if it's not checked already.

    • Check the box for Use Core API if it's not checked already.

    • Don't forget to save if you changed the permissions

  6. Securely share the credentials with y360. They will need:

    • The domain for your association. Typically the URL you are readin this on. something like [association_slug].recliquecore.com

    • The username and password you selected.

Did this answer your question?