Back to top

NameCoach Integration API v2

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/v2/names


Parameters Description

Note

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

Parameters

  • access

  • access_code: the access code for a Name Page (required parameter)

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

  • institution_id: an internal school id, provided by users import (optional parameter)

  • icon: an icon identifier for embed_image response option (optional parameter)

    • 0 - Playbutton (default)
    • 1 - Speaker 32px
    • 2 - Spkr2

Requests

Note

Every JSON response includes 4 options for embedding name recordings:

  • embed_image - play button or speaker button image that plays an audio name recording when clicked

  • embed_iframe - iframe to a lightweight playbutton that plays an audio name recording when clicked

  • recording_link - link that plays an audio name recording in a web browser

  • name_badge_link - link to a Namebadge containing the audio name recording and other cultural information about this individual

(For example renderings, see API Documentation Resources.)


To retrieve all name recordings from a Name Page:

Try it now GET/?access_code={access_code}

Parameters
HideShow
access_code
string (required) - access 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_image": "\u003cimg alt=\"Playbutton 9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1\" height=\"15\" onclick=\"javascript:(function() {\n  var audio = document.createElement(\u0026#39;audio\u0026#39;);\n  audio.src = \u0026quot;https://namewaves.s3.amazonaws.com/502.mp3?digest=38506\u0026quot;;\n  audio.play();\n}).call();\n\" src=\"https://name-coach.com/images/playbutton-9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1.png\" width=\"15\" /\u003e",
      "embed_iframe": "\u003ciframe frameborder='0' height='40' src='https://name-coach.com/playbutton/d9f2720effc29fa9075a4526fd5e20ea19d9e228' width='40'\u003e\u003c/iframe\u003e",
      "recording_link": "https://namewaves.s3.amazonaws.com/1980_2124_6C854.mp3",
      "name_badge_link": "http://www.name-coach.com/oluwarotimiadesina"
    },
    {
      "first_name": "Karla",
      "last_name": "Gleichauf",
      "email": "karla-gleichauf@example.com",
      "embed_image": "\u003cimg alt=\"Playbutton 9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1\" height=\"15\" onclick=\"javascript:(function() {\n  var audio = document.createElement(\u0026#39;audio\u0026#39;);\n  audio.src = \u0026quot;https://namewaves.s3.amazonaws.com/1980_2124_6C854.mp3?digest=38507\u0026quot;;\n  audio.play();\n}).call();\n\" src=\"https://name-coach.com/images/playbutton-9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1.png\" width=\"15\" /\u003e",
      "embed_iframe": "\u003ciframe frameborder='0' height='40' src='https://name-coach.com/playbutton/14b4a292fc9034ff65bb2523412282d71e4251ce' width='40'\u003e\u003c/iframe\u003e",
      "recording_link": "https://namewaves.s3.amazonaws.com/19.mp3",
      "name_badge_link": "http://www.name-coach.com/karlagleichauf"
    },
    {
      "first_name": "Sindura",
      "last_name": "Ravichandran",
      "email": "sindura-ravichandran@example.com",
      "embed_image": "\u003cimg alt=\"Playbutton 9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1\" height=\"15\" onclick=\"javascript:(function() {\n  var audio = document.createElement(\u0026#39;audio\u0026#39;);\n  audio.src = \u0026quot;https://namewaves.s3.amazonaws.com/19.mp3?digest=38508\u0026quot;;\n  audio.play();\n}).call();\n\" src=\"https://name-coach.com/images/playbutton-9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1.png\" width=\"15\" /\u003e",
      "embed_iframe": "\u003ciframe frameborder='0' height='40' src='https://name-coach.com/playbutton/7e2986bf7782324ce9d9eff538367f9736a41a43' width='40'\u003e\u003c/iframe\u003e",
      "recording_link": "https://namewaves.s3.amazonaws.com/502.mp3",
      "name_badge_link": "http://www.name-coach.com/sinduraravichandran"
    }
  ]
}

To retrieve an individual's name recording by email:

Try it now GET/?access_code={access_code}&email={email}

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

Example: example-237eyc55

email
string (optional) - individual's email 

Example:  oluwarotimi-adesina@example.com

institution_id
string (optional) - individual's internal school id 

Example:  example123

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "result": "success",
  "data": [
    {
      "first_name": "Oluwarotimi",
      "last_name": "Adesina",
      "email": "oluwarotimi-adesina@example.com",
      "embed_image": "\u003cimg alt=\"Playbutton 9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1\" height=\"15\" onclick=\"javascript:(function() {\n  var audio = document.createElement(\u0026#39;audio\u0026#39;);\n  audio.src = \u0026quot;https://namewaves.s3.amazonaws.com/502.mp3?digest=38506\u0026quot;;\n  audio.play();\n}).call();\n\" src=\"https://name-coach.com/images/playbutton-9814faf2f7896737e991d283f48914d0177804a8cd8d605a7321abd15c0832b1.png\" width=\"15\" /\u003e",
      "embed_iframe": "\u003ciframe frameborder='0' height='40' src='https://name-coach.com/playbutton/d9f2720effc29fa9075a4526fd5e20ea19d9e228' width='40'\u003e\u003c/iframe\u003e",
      "recording_link": "https://namewaves.s3.amazonaws.com/1980_2124_6C854.mp3",
      "name_badge_link": "http://www.name-coach.com/oluwarotimiadesina"
    }
  ]
}