Documentação

Com a API da MemberKit, você pode desenvolver sua própria integração com qualquer outra ferramenta usando o Zapier, Integromat, Microsoft Flow, Workato ou até mesmo escrever seus próprios scripts no seu servidor. Se você não tem conhecimento técnico, recomendamos que contrate um desenvolvedor para ajudá-lo nesta etapa.

Autentique sua área de membros enviando o parâmetro api_key em todas as requisições para API. Sua chave de autenticação pode ser encontrada dentro da página Configurações.

Em algumas rotas limitamos o número máximos de registros por página para 50 itens. Os dados de paginação serão retornados na resposta com os seguintes cabeçalhos que auxiliarão na construção da requisição das próximas páginas.

Cabeçalho Descrição

Cabeçalho	Descrição
`Current-Page`	Página atual
`Page-Items`	Número máximo de registros por página
`Total-Pages`	Número total de páginas
`Total-Count`	Total de registros em todas as páginas
`Link`	URLs relacionadas (Hypermedia)

Current-Page

Página atual

Page-Items

Número máximo de registros por página

Total-Pages

Número total de páginas

Total-Count

Total de registros em todas as páginas

Link

URLs relacionadas (Hypermedia)

Lista completa de todas as rotas disponíveis:

Retorna a área de membros atual.

GEThttps://memberkit.com.br/api/v1/academy

Response

Body

id*integer

name*string

subdomain*string

custom_domain*string

email*string (email)

url*string (uri)

created_at*string (date-time)

updated_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/academy', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "subdomain": "text",
  "custom_domain": "text",
  "email": "name@gmail.com",
  "url": "https://example.com",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z"
}

Retorna uma lista de cursos cadastrados.

GEThttps://memberkit.com.br/api/v1/courses

Query parameters

Response

Body

id*integer

name*string

description*string

position*integer

image_url*nullable string

page_checkout_url*nullable string

created_at*string (date-time)

updated_at*string (date-time)

category*Category

Request

const response = await fetch('https://memberkit.com.br/api/v1/courses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "description": "text",
    "image_url": "text",
    "page_checkout_url": "text",
    "created_at": "2024-04-28T12:19:45.448Z",
    "updated_at": "2024-04-28T12:19:45.448Z",
    "category": {
      "name": "text"
    }
  }
]

Retorna um curso específico através do ID.

GEThttps://memberkit.com.br/api/v1/courses/{id}

Path parameters

id*integer

ID do curso

Response

Body

id*integer

name*string

description*string

position*integer

image_url*nullable string

page_checkout_url*nullable string

created_at*string (date-time)

updated_at*string (date-time)

category*Category

sectionsarray of object

Request

const response = await fetch('https://memberkit.com.br/api/v1/courses/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "image_url": "text",
  "page_checkout_url": "text",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z",
  "category": {
    "name": "text"
  },
  "sections": [
    {
      "name": "text",
      "slug": "text",
      "description": "text",
      "created_at": "2024-04-28T12:19:45.448Z",
      "updated_at": "2024-04-28T12:19:45.448Z",
      "lessons": [
        {
          "slug": "text",
          "title": "text"
        }
      ]
    }
  ]
}

Retorna uma aula específica através do ID do curso e aula.

Retorna o conteúdo, metadados do vídeo e links dos materiais de uma aula.

GEThttps://memberkit.com.br/api/v1/courses/{course_id}/lessons/{id}

Path parameters

course_id*integer

ID do curso

id*integer

ID da aula

Response

Body

id*integer

slug*string

position*integer

title*string

content*string

created_at*string (date-time)

updated_at*string (date-time)

videoobject

filesarray of object

Request

const response = await fetch('https://memberkit.com.br/api/v1/courses/{course_id}/lessons/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "slug": "text",
  "title": "text",
  "content": "text",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z",
  "video": {
    "uid": "text",
    "source": "text",
    "image": "text"
  },
  "files": [
    {
      "url": "text",
      "content_type": "text",
      "filename": "text",
      "created_at": "2024-04-28T12:19:45.448Z"
    }
  ]
}

Retorna uma lista de níveis de assinatura.

GEThttps://memberkit.com.br/api/v1/membership_levels

Response

Body

id*integer

name*string

trial_period*integer

classroom_ids*array of integer

created_at*string (date-time)

updated_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/membership_levels', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "classroom_ids": [],
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z"
}

Retorna uma lista de assinantes.

GEThttps://memberkit.com.br/api/v1/memberships

Query parameters

Response

Body

id*integer

status*enum

inactivependingactiveexpired

membership_level_id*integer

expire_date*string (date-time)

user*User

Request

const response = await fetch('https://memberkit.com.br/api/v1/memberships', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "status": "inactive",
    "expire_date": "2024-04-28T12:19:45.448Z",
    "user": {
      "full_name": "text",
      "email": "name@gmail.com",
      "profile_image_url": "text",
      "current_sign_in_at": "2024-04-28T12:19:45.448Z",
      "created_at": "2024-04-28T12:19:45.448Z",
      "updated_at": "2024-04-28T12:19:45.448Z"
    }
  }
]

Retorna uma lista de turmas.

GEThttps://memberkit.com.br/api/v1/classrooms

Response

Body

id*integer

name*string

master*boolean

course_name*string

users_count*integer

comments_count*integer

average_progress*integer

created_at*string (date-time)

updated_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/classrooms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "text",
    "master": false,
    "course_name": "text",
    "created_at": "2024-04-28T12:19:45.448Z",
    "updated_at": "2024-04-28T12:19:45.448Z"
  }
]

Retorna uma turma específica através do ID.

GEThttps://memberkit.com.br/api/v1/classrooms/{id}

Path parameters

id*integer

Response

Body

id*integer

name*string

master*boolean

course_name*string

users_count*integer

comments_count*integer

average_progress*integer

created_at*string (date-time)

updated_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/classrooms/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "master": false,
  "course_name": "text",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z"
}

Retorna lista de submissões de quizzes

GEThttps://memberkit.com.br/api/v1/quiz_attempts

Query parameters

Response

Body

id*integer

answered_questions_count*integer

correct_answers_count*integer

quiz*object

user*User

started_at*string

created_at*string

updated_at*string

Request

const response = await fetch('https://memberkit.com.br/api/v1/quiz_attempts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "quiz": {
      "title": "text",
      "description": "text"
    },
    "user": {
      "full_name": "text",
      "email": "name@gmail.com",
      "profile_image_url": "text",
      "current_sign_in_at": "2024-04-28T12:19:45.448Z",
      "created_at": "2024-04-28T12:19:45.448Z",
      "updated_at": "2024-04-28T12:19:45.448Z"
    },
    "started_at": "text",
    "created_at": "text",
    "updated_at": "text"
  }
]

Retorna uma submissão de quiz através do ID.

GEThttps://memberkit.com.br/api/v1/quiz_attempts/{id}

Path parameters

id*integer

Response

Body

id*integer

answered_questions_count*integer

correct_answers_count*integer

quiz*object

user*User

started_at*string

created_at*string

updated_at*string

question_responses*array of object

Request

const response = await fetch('https://memberkit.com.br/api/v1/quiz_attempts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "quiz": {
    "title": "text",
    "description": "text"
  },
  "user": {
    "full_name": "text",
    "email": "name@gmail.com",
    "profile_image_url": "text",
    "current_sign_in_at": "2024-04-28T12:19:45.448Z",
    "created_at": "2024-04-28T12:19:45.448Z",
    "updated_at": "2024-04-28T12:19:45.448Z"
  },
  "started_at": "text",
  "created_at": "text",
  "updated_at": "text",
  "question_responses": [
    {
      "question": {
        "body": "text"
      },
      "answer": {
        "body": "text"
      },
      "is_correct": false
    }
  ]
}

Retorna uma lista de ranking dos membros.

GEThttps://memberkit.com.br/api/v1/rankings

Query parameters

Response

Body

position*integer

score*integer

user*User

Request

const response = await fetch('https://memberkit.com.br/api/v1/rankings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "user": {
      "full_name": "text",
      "email": "name@gmail.com",
      "profile_image_url": "text",
      "current_sign_in_at": "2024-04-28T12:19:45.448Z",
      "created_at": "2024-04-28T12:19:45.448Z",
      "updated_at": "2024-04-28T12:19:45.448Z"
    }
  }
]

Retorna uma lista de membros.

GEThttps://memberkit.com.br/api/v1/users

Query parameters

Response

Body

id*integer

full_name*string

email*string (email)

profile_image_url*nullable string

sign_in_count*integer

current_sign_in_at*nullable string (date-time)

created_at*string (date-time)

updated_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "full_name": "text",
    "email": "name@gmail.com",
    "profile_image_url": "text",
    "current_sign_in_at": "2024-04-28T12:19:45.448Z",
    "created_at": "2024-04-28T12:19:45.448Z",
    "updated_at": "2024-04-28T12:19:45.448Z"
  }
]

Cadastra ou atualiza um membro através do email.

Utilize este método para criar membro, liberar ou bloquear acesso a um conteúdo específico. Essa rota é cumulativa, ou seja, você não precisa informar a lista e status de todas matrículas existentes.

Há três tipos de matrícula na MemberKit: cursos individuais, acesso ilimitado ou assinatura. Ao enviar sua requisição, use apenas uma modalidade de inscrição usando o parâmetro classroom_ids, unlimited ou membership_level_id respectivamente.

POSThttps://memberkit.com.br/api/v1/users

Body

full_name*string

Nome completo

email*string (email)

Endereço de email

status*enum

inactivependingactiveexpired

blockedboolean

Status de banimento de conta

unlimitedboolean

Acesso ilimitado

classroom_idsarraystring

IDs de turmas

membership_level_idinteger

ID do nível de assinatura

expires_atstring (date-time)

Data de expiração

cpf_cnpjstring

CPF/CNPJ

phone_local_codestring

DDD do telefone

phone_numberstring

Número do telefone

Response

Created

Body

id*integer

full_name*string

email*string (email)

bio*string

profile_image_url*nullable string

blocked*boolean

unlimited*boolean

sign_in_count*integer

current_sign_in_at*nullable string (date-time)

created_at*string (date-time)

updated_at*string (date-time)

metadata*object

enrollments*array of object

memberships*array of object

Request

const response = await fetch('https://memberkit.com.br/api/v1/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "full_name": "text",
      "email": "name@gmail.com",
      "status": "inactive"
    }),
});
const data = await response.json();

Response

{
  "full_name": "text",
  "email": "name@gmail.com",
  "bio": "text",
  "profile_image_url": "text",
  "blocked": false,
  "unlimited": false,
  "current_sign_in_at": "2024-04-28T12:19:45.448Z",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z",
  "metadata": {
    "cpf_cnpj": "text",
    "phone_local_code": "text",
    "phone_number": "text"
  },
  "enrollments": [
    {
      "status": "inactive",
      "expire_date": "2024-04-28"
    }
  ],
  "memberships": [
    {
      "status": "inactive",
      "expire_date": "2024-04-28T12:19:45.448Z"
    }
  ]
}

Retorna um membro através do ID ou email.

GEThttps://memberkit.com.br/api/v1/users/{id}

Path parameters

id*string

Response

Body

id*integer

full_name*string

email*string (email)

bio*string

profile_image_url*nullable string

blocked*boolean

unlimited*boolean

sign_in_count*integer

current_sign_in_at*nullable string (date-time)

created_at*string (date-time)

updated_at*string (date-time)

metadata*object

enrollments*array of object

memberships*array of object

Request

const response = await fetch('https://memberkit.com.br/api/v1/users/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "full_name": "text",
  "email": "name@gmail.com",
  "bio": "text",
  "profile_image_url": "text",
  "blocked": false,
  "unlimited": false,
  "current_sign_in_at": "2024-04-28T12:19:45.448Z",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z",
  "metadata": {
    "cpf_cnpj": "text",
    "phone_local_code": "text",
    "phone_number": "text"
  },
  "enrollments": [
    {
      "status": "inactive",
      "expire_date": "2024-04-28"
    }
  ],
  "memberships": [
    {
      "status": "inactive",
      "expire_date": "2024-04-28T12:19:45.448Z"
    }
  ]
}

Atualiza um membro específico através do ID ou email.

Utilize este método para atualizar o perfil do membro.

PUThttps://memberkit.com.br/api/v1/users/{id}

Path parameters

id*string

Body

full_namestring

Nome completo

emailstring (email)

Endereço de email

biostring

Bio

unlimitedboolean

Acesso ilimitado

blockedboolean

Status de banimento

time_zonestring

Fuso horário

deleted_atstring (date-time)

Data de arquivamento

metadataobject

Metadados

Response

Body

id*integer

full_name*string

email*string (email)

bio*string

profile_image_url*nullable string

blocked*boolean

unlimited*boolean

sign_in_count*integer

current_sign_in_at*nullable string (date-time)

created_at*string (date-time)

updated_at*string (date-time)

metadata*object

enrollments*array of object

memberships*array of object

Request

const response = await fetch('https://memberkit.com.br/api/v1/users/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "full_name": "text",
  "email": "name@gmail.com",
  "bio": "text",
  "profile_image_url": "text",
  "blocked": false,
  "unlimited": false,
  "current_sign_in_at": "2024-04-28T12:19:45.448Z",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z",
  "metadata": {
    "cpf_cnpj": "text",
    "phone_local_code": "text",
    "phone_number": "text"
  },
  "enrollments": [
    {
      "status": "inactive",
      "expire_date": "2024-04-28"
    }
  ],
  "memberships": [
    {
      "status": "inactive",
      "expire_date": "2024-04-28T12:19:45.448Z"
    }
  ]
}

Arquiva um membro específico através do ID ou email.

DELETEhttps://memberkit.com.br/api/v1/users/{id}

Path parameters

id*string

Response

No Content

Request

const response = await fetch('https://memberkit.com.br/api/v1/users/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Retorna uma lista de pontuações de um membro específico.

GEThttps://memberkit.com.br/api/v1/users/{user_id}/rankings

Path parameters

user_id*string

Response

Body

id*integer

score*integer

progress*integer

course_id*integer

classroom_id*integer

computed_expire_date*string (date)

Request

const response = await fetch('https://memberkit.com.br/api/v1/users/{user_id}/rankings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "computed_expire_date": "2024-04-28"
  }
]

Retorna feed de atividades de um membro específico.

GEThttps://memberkit.com.br/api/v1/users/{user_id}/activities

Path parameters

user_id*string

Query parameters

Response

Body

id*integer

course_id*integer

lesson_id*integer

trackable_type*string

trackable*object

created_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/users/{user_id}/activities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "trackable_type": "text",
    "created_at": "2024-04-28T12:19:45.448Z"
  }
]

Cadastra uma pontuação para um membro específico.

POSThttps://memberkit.com.br/api/v1/scores

Body

reason*string

Motivo da pontuação

value*integer

Quantidade de pontos

user_email*string

Email do membro

course_id*integer

ID do curso

Response

Created

Body

id*integer

value*integer

reason*string

course_id*integer

created_at*string (date-time)

updated_at*string (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/scores', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reason": "text",
      "user_email": "text"
    }),
});
const data = await response.json();

Response

{
  "reason": "text",
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z"
}

Remove uma pontuação de um membro específico.

DELETEhttps://memberkit.com.br/api/v1/scores

Body

user_email*string

Email do membro

reason*string

Texto exato do motivo da pontuação

course_id*integer

ID do curso

Response

No Content

Request

const response = await fetch('https://memberkit.com.br/api/v1/scores', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_email": "text",
      "reason": "text"
    }),
});
const data = await response.json();

Gera um token de login para um membro específico.

Logue um membro sem ter que digitar o email e senha no formulário de login. Redirecione o membro para a URL de entrada da sua área de membros com o parâmetro token preenchido.

O token gerado expira em 1 hora. Mas após logado, a sessão tem duração de 2 semanas. Por questão de segurança, não é possível gerar tokens para contas administrativas.

POSThttps://memberkit.com.br/api/v1/tokens

Body

email*string (email)

Email do membro

Response

Created

Body

token*string

authenticated_urlstring

Request

const response = await fetch('https://memberkit.com.br/api/v1/tokens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "name@gmail.com"
    }),
});
const data = await response.json();

Response

{
  "token": "text",
  "authenticated_url": "text"
}

Retorna lista de webhooks para notificações.

GEThttps://memberkit.com.br/api/v1/hooks

Query parameters

Response

Body

idinteger

urlstring

statusstring

eventsarray of string

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/hooks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "url": "text",
    "status": "text",
    "events": [
      "text"
    ],
    "created_at": "2024-04-28T12:19:45.448Z",
    "updated_at": "2024-04-28T12:19:45.448Z"
  }
]

Cadastra uma nova URL de notificação.

POSThttps://memberkit.com.br/api/v1/hooks

Body

urlstring

URL de notificação

statusenum

inactiveactive

eventsarray of string

Lista de eventos permitidos no cadastro de webhooks.

comment_created - Comentário criado
enrollment_created - Matrícula criada
enrollment_updated - Matrícula atualizada
integration_log_received - Oferta transacionada
lesson_created - Aula criada
lesson_status_saved - Progresso atualizada
lesson_updated - Aula atualizada
membership_created - Assinatura criada
membership_updated - Assinatura atualizada
rating_saved - Avaliação feita
user_login_sent - Login enviado
user_signed_in - Login feito
user_last_seen - Última vez visto

Response

Created

Body

idinteger

urlstring

statusstring

eventsarray of string

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/hooks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text",
  "status": "text",
  "events": [
    "text"
  ],
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z"
}

Atualiza um webhook específico através do ID.

PUThttps://memberkit.com.br/api/v1/hooks/{id}

Path parameters

id*integer

ID do webhook

Body

urlstring

statusenum

inactiveactive

eventsarray of string

Response

Body

idinteger

urlstring

statusstring

eventsarray of string

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('https://memberkit.com.br/api/v1/hooks/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "url": "text",
  "status": "text",
  "events": [
    "text"
  ],
  "created_at": "2024-04-28T12:19:45.448Z",
  "updated_at": "2024-04-28T12:19:45.448Z"
}

Remove um webhook específico através do ID.

DELETEhttps://memberkit.com.br/api/v1/hooks/{id}

Path parameters

id*integer

ID do webhook

Response

No Content

Request

const response = await fetch('https://memberkit.com.br/api/v1/hooks/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

PreviousHeroSpark

Last updated 1 month ago