Visão geral

A integração com General Bank se dá por meio de requisições HTTP em que estão disponíveis endpoints que permitem um aluno (identificado pelo email) receber um ou mais planos assim como remover plano de um aluno.

Todas requisições devem ser realizadas no seguinte endereço da API: https://login.xgrow.com no respectivo caminho de cada endpoint detalhado abaixo

Header de autenticação

Todas as requisições devem obrigatoriamente conter o header X-General-Bank-Token com o respectivo token para que as requisições sejam válidas.

Adicionando planos para um aluno

Para obter o código de cada plano confira o passo a passo em Obtendo código do plano

Adiciona/atualiza um aluno, liberando acesso aos planos definidos.

PUT /api/webhooks/general-bank/subscribers/{email}/plans
{
  "plan_ids": [1, 2],
  "name": "Nome do aluno",
  "document": "012.345.678-90",
  "phone": "(99) 99999-9999",
  "address": "Avenida Principal 123"
}

Campo	Obrigatoriedade	Tipo

Campo	Obrigatoriedade	Tipo
plan_ids	Obrigatório	Array de inteiros
name	Obrigatório	String
document	Opcional	String
phone	Opcional	String
address	Opcional	String

Removendo plano de um aluno

Cancela o acesso de um plano ao aluno

DELETE /api/webhooks/general-bank/subscribers/{email}/plans/{planId}