eymanage - REST API's

This page documents the Public API for eymanage platform of eyworks.

eymanage uses a standard OAuth 2.0 system. Postman can be useful to test your API calls without having to code anything. We’ve created a Postman collection that makes authentication easy. Postman is a REST client that provides an intuitive user interface to send requests, save responses, add tests, and create workflows.

Steps to get up and running

Import the eymanage OAuth 2.0 collection and environment into Postman

Click the button below and select the Desktop version of Postman (Chrome extension doesn’t support environment variables). This will also install the Collection and Environment we’ll be using.

Create an OAuth2 app

To initiate the OAuth2 app creation process, kindly contact our Support Team via support@eyworks.co.uk. They will require essential information from you to configure the Client ID and Client Secret. These details can be subsequently imported into the collection variables of your Postman Collection, enabling the generation of your initial access token. Remember to communicate with the support team if you wish to restrict access to a specific nursery or a group of nurseries.

Add your first set of environment variables in Postman

Copy the Client ID, Client Secret, and Base URL provided by the eyworks support team to the environment variables in Postman. To add these details to the Environment, make sure you have the OAuth 2.0 Environment selected, and then add the values to the Current Value field.

Click Save once the values have been entered correctly.

Generate your first access token

1. Click on the POST Access Token request under the OAuth folder.

2. Click Send.

3. If everything is set up properly, you will see a response that will include an access token which will be valid for the next 60 minutes. The access token will be automatically set as a Bearer Token in the Authorization Header for every request. You can also set it manually by clicking the Header section of the Request.

Make your first API call

1. Click to load the GET Nurseries request under the Nursery folder

2. Click Send

• Related Articles

• Making a child’s profile inactive on eymanage

  You can indicate that a child has left the nursery by making their profile inactive. This will move their profile to an inactive list, and lock it so you're unable to update information, schedule sessions, create terms, etc. Making a child inactive ...

• Creating an eymanage staff login

  When filling in a staff member’s profile, you have the option to create an eymanage staff login for them. This way, staff members can access a limited version of eymanage using the Primary Email entered into their profile. You will need to create ...

• Making a child active on eymanage

  Inactive children are hidden on the system, which limits nearly all their system functions. To restore system functionality, you must make the child active again. Click on Children in the sidebar. Click on Filters in the top left. Check the box next ...

• Downloading data from eymanage and eyenquiries

  What follows is a list of the kinds of data you can download off eymanage, from where, and in which formats. With eymanage, you can either download data directly from a section of the system, or generate the data you need from the Reports tab. You ...

• Creating a profile on eylog from eymanage

  While filling in a staff member’s profile form, you’re given the option to also create a profile for them on eylog using the information stored for them on eymanage. When adding a new staff member Click on Staff in the sidebar. Click on the icon in ...