Back to top

NameCoach Integration API v1

This API is used to integrate name pronunciation recordings with displayed names and profiles of members of your organization (employees, faculty, staff, students, etc.)

Typical online systems in which name pronunciation recordings are embedded include:

  • Private or Public Directory
  • SIS (Student Information System)
  • LMS (Learning Management System)
  • HCM (Human Capital Management) System
  • CRM (Customer Relationship Management) System

Endpoint:  https://www.name-coach.com/api/private/v1/students


Parameters Description

Note

The event_code is the code that 1-to-1 maps to a Name Page (see demo Name Page). After subscribed to our Integration Service, you will get a code that retrieves name recordings for all members of your institution (not just those on a given Name Page.)

Parameters

  • event_code: the code for a Name Page - (required parameter)

  • email: email of a particular individual whose name recording you want to retrieve (optional parameter)

Presetting

Note

Add the following playbutton.js script to your HEAD section. Also ensure that you have jQuery installed. (only for embedcodes).

Script

<script src="https://www.name-coach.com/vendor/playbutton.js"></script>

Embed Codes

To retrieve all name recordings from a Name Page:

Try it now GET/embedcodes/{event_code}.json

The response contains a list of students and their embed codes (including play button images)

Parameters
HideShow
event_code
string (required) - code for a Name Page 

Example: example-237eyc55

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "result": "success",
  "data": [
    {
      "first_name": "Oluwarotimi",
      "last_name": "Adesina",
      "email": "oluwarotimi-adesina@example.com",
      "embed_html": "<img alt=\"Playbutton\" framesrc=\"https://www.name-coach.com/leanplaybutton/38507\" src=\"http://www.name-coach.com/images/playbutton.png\" style=\"width:15px; height:15px;\" type=\"namecoachplaybutton\" />"
    },
    {
      "first_name": "Karla",
      "last_name": "Gleichauf",
      "email": "karla-gleichauf@example.com",
      "embed_html": "<img alt=\"Playbutton\" framesrc=\"https://www.name-coach.com/leanplaybutton/38508\" src=\"http://www.name-coach.com/images/playbutton.png\" style=\"width:15px; height:15px;\" type=\"namecoachplaybutton\" />"
    },
    {
      "first_name": "Sindura",
      "last_name": "Ravichandran",
      "email": "sindura-ravichandran@example.com",
      "embed_html": "<img alt=\"Playbutton\" framesrc=\"https://www.name-coach.com/leanplaybutton/38506\" src=\"http://www.name-coach.com/images/playbutton.png\" style=\"width:15px; height:15px;\" type=\"namecoachplaybutton\" />"
    }
  ]
}

To retrieve an individual's name recording by email:

Try it now GET/embedcodes/{event_code}.json?email={email}

The response contains a single student's information and their embed code (including a play button image)

Parameters
HideShow
event_code
string (required) - code for a Name Page 

Example: example-237eyc55

email
string (required) - individual's email 

Example:  oluwarotimi-adesina@example.com

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "result": "success",
  "data": [
    {
      "first_name": "Oluwarotimi",
      "last_name": "Adesina",
      "email": "oluwarotimi-adesina@example.com",
      "embed_html": "<img alt=\"Playbutton\" framesrc=\"https://www.name-coach.com/leanplaybutton/38507\" src=\"http://www.name-coach.com/images/playbutton.png\" style=\"width:15px; height:15px;\" type=\"namecoachplaybutton\" />"
    }
  ]
}