Back to top
Captação integrada   By  Hover Leads

Captação Integrada

API_Rest para integração com o software Captação Integrada A autenticação é feita diretamente por meio de Bearer Token. Para isso, usa-se o cabeçalho Authorization, conforme exemplos descrito a seguir.

Mais informações sobre como usar autenticação por Bearer Token: https://developer.twitter.com/en/docs/authentication/oauth-2-0/bearer-tokens

Caminho Base

Caminho base para homologação:

https://doe-homolog.prorim.org.br/api

Exemplo completo de URL de um endpoint:

https://doe-homolog.prorim.org.br/api/afiliados/?id=10

Autenticação

Exemplo de Header para autenticação:

Accept: application/json
Authorization: Bearer jpxrtm6z2x3hx9ylxkiusp2hbxnieaybt276vplg

Todos os tipos de requisições para todos os Endpoints devem conter o cabeçalho Authorization.


Afiliados

Afiliados

Lista de Afiliados

Listar Afiliados
GET/afiliados/{?id,tag_name,nome_completo,email,cpf,genero,tipoId,status}

Lista os afiliados. É possível filtrar por qualquer campo.

Atenção!

Caso nenhum parâmetro seja especificado, serão listados TODOS os afiliados. Recomenda-se no mínimo especificar tipoId=1 para buscar apenas operadores do call-center ou tipoId=XX para outro grupo de afiliados, onde XX é um número inteiro. Verifique os grupos de afiliados no endpoint /afiliados-tipos

Example URI

GET /afiliados/?id=10&tag_name=MA12345&nome_completo=joao da silva&email=joaodasilva@gmal.com&cpf=22233344455&genero=masculino&tipoId=1&status=1
URI Parameters
HideShow
id
number (optional) Example: 10

ID interno

tag_name
string (optional) Example: MA12345

Tag do Afiliado

nome_completo
string (optional) Example: joao da silva

Nome Completo

email
string (optional) Example: joaodasilva@gmal.com

Email do afiliado

cpf
number (optional) Example: 22233344455

CPF (apenas números!)

genero
string (optional) Example: masculino

Gênero

Choices: masculino feminino

tipoId
number (optional) Example: 1

Tipo de Afiliado.

status
number (optional) Example: 1

Status (Ativo/Inativo)

Choices: 0 1

Request  Listar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "nome_completo": "João da Silva",
    "cpf": 22233344455,
    "email": "joaodasilva@gmail.com",
    "telefone": 47999999999,
    "celular": 47999999999,
    "genero": "masculino",
    "data_nascimento": "1969-12-31",
    "tag_name": "MA12345",
    "observacao": "Observação teste",
    "endereco_cep": 89237003,
    "endereco_logradouro": "Rua Xavier Arp",
    "endereco_numero": 589,
    "endereco_complemento": "apt. 43",
    "endereco_bairro": "Boa Vista",
    "endereco_cidade": "Joinville",
    "endereco_uf": "SC",
    "dateCreated": "2021-10-18 11:19:23",
    "dateUpdated": "2021-10-18 11:19:23",
    "status": 1,
    "tipoId": 1,
    "authorId": 1
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Cadastrar Afiliado
POST/afiliados/

Cadastra um novo afiliado.

Example URI

POST /afiliados/
Request  Cadastrar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Body
{
  "nome_completo": "João da Silva",
  "cpf": 22233344455,
  "email": "joaodasilva@gmail.com",
  "telefone": 47999999999,
  "celular": 47999999999,
  "genero": "masculino",
  "data_nascimento": "1969-12-31",
  "tag_name": "MA12345",
  "observacao": "Observação teste",
  "endereco_cep": 89237003,
  "endereco_logradouro": "Rua Xavier Arp",
  "endereco_numero": 589,
  "endereco_complemento": "apt. 43",
  "endereco_bairro": "Boa Vista",
  "endereco_cidade": "Joinville",
  "endereco_uf": "SC",
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "status": 1,
  "tipoId": 1,
  "authorId": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "nome_completo": {
      "type": "string",
      "description": "Nome completo do afiliado"
    },
    "cpf": {
      "type": "number",
      "description": "CPF do afiliado * APENAS NÚMEROS"
    },
    "email": {
      "type": "string",
      "description": "E-mail do afilidado"
    },
    "telefone": {
      "type": "number",
      "description": "Telefone * APENAS NÚMEROS, incluindo DDD"
    },
    "celular": {
      "type": "number",
      "description": "Celular * APENAS NÚMEROS, incluindo DDD"
    },
    "genero": {
      "type": "string",
      "description": "\"masculino\" ou \"feminino\""
    },
    "data_nascimento": {
      "type": "string",
      "description": "Data de nascimento"
    },
    "tag_name": {
      "type": "string",
      "description": "Identificador do afiliado. Obrigatoriamente no formato AA00000 (duas strings e 5 números)"
    },
    "observacao": {
      "type": "string",
      "description": "Observação"
    },
    "endereco_cep": {
      "type": "number",
      "description": "CEP da rua: Apenas números"
    },
    "endereco_logradouro": {
      "type": "string",
      "description": "Nome da rua"
    },
    "endereco_numero": {
      "type": "number",
      "description": "Número do endereço"
    },
    "endereco_complemento": {
      "type": "string",
      "description": "Complemento"
    },
    "endereco_bairro": {
      "type": "string",
      "description": "Nome do Bairro"
    },
    "endereco_cidade": {
      "type": "string",
      "description": "Nome da Cidade"
    },
    "endereco_uf": {
      "type": "string",
      "description": "UF no formado 2 letras"
    },
    "dateCreated": {
      "type": "string",
      "description": "timestamp"
    },
    "dateUpdated": {
      "type": "string",
      "description": "timestamp"
    },
    "status": {
      "type": "number",
      "description": "se o afiliado está ativo (1) ou inativo (0)"
    },
    "tipoId": {
      "type": "number",
      "description": "A qual grupo de afiliado ele pertence. Para operadores de Call-center usar: 1"
    },
    "authorId": {
      "type": "number",
      "description": "Qual usuário do sistema cadastrou este afiliado"
    }
  },
  "required": [
    "nome_completo",
    "cpf",
    "email"
  ]
}
Response  201
OcultarShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "nome_completo": "João da Silva",
  "cpf": 22233344455,
  "email": "joaodasilva@gmail.com",
  "telefone": 47999999999,
  "celular": 47999999999,
  "genero": "masculino",
  "data_nascimento": "1969-12-31",
  "tag_name": "MA12345",
  "observacao": "Observação teste",
  "endereco_cep": 89237003,
  "endereco_logradouro": "Rua Xavier Arp",
  "endereco_numero": 589,
  "endereco_complemento": "apt. 43",
  "endereco_bairro": "Boa Vista",
  "endereco_cidade": "Joinville",
  "endereco_uf": "SC",
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "status": 1,
  "tipoId": 1,
  "authorId": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID interno do afiliado"
    },
    "nome_completo": {
      "type": "string",
      "description": "Nome completo do afiliado"
    },
    "cpf": {
      "type": "number",
      "description": "CPF do afiliado * APENAS NÚMEROS"
    },
    "email": {
      "type": "string",
      "description": "E-mail do afilidado"
    },
    "telefone": {
      "type": "number",
      "description": "Telefone * APENAS NÚMEROS, incluindo DDD"
    },
    "celular": {
      "type": "number",
      "description": "Celular * APENAS NÚMEROS, incluindo DDD"
    },
    "genero": {
      "type": "string",
      "description": "\"masculino\" ou \"feminino\""
    },
    "data_nascimento": {
      "type": "string",
      "description": "Data de nascimento"
    },
    "tag_name": {
      "type": "string",
      "description": "Identificador do afiliado. Obrigatoriamente no formato AA00000 (duas strings e 5 números)"
    },
    "observacao": {
      "type": "string",
      "description": "Observação"
    },
    "endereco_cep": {
      "type": "number",
      "description": "CEP da rua: Apenas números"
    },
    "endereco_logradouro": {
      "type": "string",
      "description": "Nome da rua"
    },
    "endereco_numero": {
      "type": "number",
      "description": "Número do endereço"
    },
    "endereco_complemento": {
      "type": "string",
      "description": "Complemento"
    },
    "endereco_bairro": {
      "type": "string",
      "description": "Nome do Bairro"
    },
    "endereco_cidade": {
      "type": "string",
      "description": "Nome da Cidade"
    },
    "endereco_uf": {
      "type": "string",
      "description": "UF no formado 2 letras"
    },
    "dateCreated": {
      "type": "string",
      "description": "timestamp"
    },
    "dateUpdated": {
      "type": "string",
      "description": "timestamp"
    },
    "status": {
      "type": "number",
      "description": "se o afiliado está ativo (1) ou inativo (0)"
    },
    "tipoId": {
      "type": "number",
      "description": "A qual grupo de afiliado ele pertence. Para operadores de Call-center usar: 1"
    },
    "authorId": {
      "type": "number",
      "description": "Qual usuário do sistema cadastrou este afiliado"
    }
  },
  "required": [
    "nome_completo",
    "cpf",
    "email"
  ]
}

Atualizar Afiliado
PUT/afiliados/{?id,tag_name,cpf}

Atualiza o cadastro de um afiliado. Para especificar qual afiliado deve ser atualizado, utilize um dos parâmetros disponíveis. Preferencialmente, utilize o parâmetro id

Example URI

PUT /afiliados/?id=10&tag_name=MA12345&cpf=22233344455
URI Parameters
HideShow
id
number (optional) Example: 10

ID interno

tag_name
string (optional) Example: MA12345

Tag do Afiliado

cpf
number (optional) Example: 22233344455

CPF (apenas números)

Request  Atualizar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Body
{
  "nome_completo": "João da Silva",
  "cpf": 22233344455,
  "email": "joaodasilva@gmail.com",
  "telefone": 47999999999,
  "celular": 47999999999,
  "genero": "masculino",
  "data_nascimento": "1969-12-31",
  "tag_name": "MA12345",
  "observacao": "Observação teste",
  "endereco_cep": 89237003,
  "endereco_logradouro": "Rua Xavier Arp",
  "endereco_numero": 589,
  "endereco_complemento": "apt. 43",
  "endereco_bairro": "Boa Vista",
  "endereco_cidade": "Joinville",
  "endereco_uf": "SC",
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "status": 1,
  "tipoId": 1,
  "authorId": 1
}
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "nome_completo": "João da Silva",
  "cpf": 22233344455,
  "email": "joaodasilva@gmail.com",
  "telefone": 47999999999,
  "celular": 47999999999,
  "genero": "masculino",
  "data_nascimento": "1969-12-31",
  "tag_name": "MA12345",
  "observacao": "Observação teste",
  "endereco_cep": 89237003,
  "endereco_logradouro": "Rua Xavier Arp",
  "endereco_numero": 589,
  "endereco_complemento": "apt. 43",
  "endereco_bairro": "Boa Vista",
  "endereco_cidade": "Joinville",
  "endereco_uf": "SC",
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "status": 1,
  "tipoId": 1,
  "authorId": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID interno do afiliado"
    },
    "nome_completo": {
      "type": "string",
      "description": "Nome completo do afiliado"
    },
    "cpf": {
      "type": "number",
      "description": "CPF do afiliado * APENAS NÚMEROS"
    },
    "email": {
      "type": "string",
      "description": "E-mail do afilidado"
    },
    "telefone": {
      "type": "number",
      "description": "Telefone * APENAS NÚMEROS, incluindo DDD"
    },
    "celular": {
      "type": "number",
      "description": "Celular * APENAS NÚMEROS, incluindo DDD"
    },
    "genero": {
      "type": "string",
      "description": "\"masculino\" ou \"feminino\""
    },
    "data_nascimento": {
      "type": "string",
      "description": "Data de nascimento"
    },
    "tag_name": {
      "type": "string",
      "description": "Identificador do afiliado. Obrigatoriamente no formato AA00000 (duas strings e 5 números)"
    },
    "observacao": {
      "type": "string",
      "description": "Observação"
    },
    "endereco_cep": {
      "type": "number",
      "description": "CEP da rua: Apenas números"
    },
    "endereco_logradouro": {
      "type": "string",
      "description": "Nome da rua"
    },
    "endereco_numero": {
      "type": "number",
      "description": "Número do endereço"
    },
    "endereco_complemento": {
      "type": "string",
      "description": "Complemento"
    },
    "endereco_bairro": {
      "type": "string",
      "description": "Nome do Bairro"
    },
    "endereco_cidade": {
      "type": "string",
      "description": "Nome da Cidade"
    },
    "endereco_uf": {
      "type": "string",
      "description": "UF no formado 2 letras"
    },
    "dateCreated": {
      "type": "string",
      "description": "timestamp"
    },
    "dateUpdated": {
      "type": "string",
      "description": "timestamp"
    },
    "status": {
      "type": "number",
      "description": "se o afiliado está ativo (1) ou inativo (0)"
    },
    "tipoId": {
      "type": "number",
      "description": "A qual grupo de afiliado ele pertence. Para operadores de Call-center usar: 1"
    },
    "authorId": {
      "type": "number",
      "description": "Qual usuário do sistema cadastrou este afiliado"
    }
  },
  "required": [
    "nome_completo",
    "cpf",
    "email"
  ]
}

Apagar Afiliado
DELETE/afiliados/{?id,tag_name,cpf}

Deleta um afiliado. Caso o afiliado possua doações registradas, ele é desativado, através de status=0. Para especificar qual afiliado deve ser excluído, utilize um dos parâmetros disponíveis. Preferencialmente, utilize o parâmetro id

Example URI

DELETE /afiliados/?id=10&tag_name=MA12345&cpf=22233344455
URI Parameters
HideShow
id
number (optional) Example: 10

ID interno

tag_name
string (optional) Example: MA12345

Tag do Afiliado

cpf
number (optional) Example: 22233344455

CPF

Request  Apagar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
{
  "type": "success",
  "message": "Afiliado excluído com sucesso"
}

Grupo de Afiliados

Grupos de afiliados são categorias de afiliados, usados para separa os registros e facilitar a expansão do sistema no futuro. Internamente, os grupos são chamados de “tipos”, por esta rasão o endpoint chama-se /afiliados-tipos/

Listar Grupos
GET/afiliados-tipos/{?id,name,description,slug,status}

Lista os grupos de afiliados. É possível filtrar por qualquer campo.

Example URI

GET /afiliados-tipos/?id=10&name=Operadores Call Center&description=Grupo dos Funcionários do Call Center&slug=operadores-call-center&status=1
URI Parameters
HideShow
id
number (optional) Example: 10

ID interno

name
string (optional) Example: Operadores Call Center

Nome do Grupo de Afiliado

description
string (optional) Example: Grupo dos Funcionários do Call Center

Descrição para o grupo

slug
string (optional) Example: operadores-call-center

Slug (referência interna)

status
number (optional) Example: 1

Status do Grupo (1 = ativo, 0 = inativo)

Request  Listar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 10,
    "name": "Operadores Call Center",
    "description": "Grupo dos Funcionários do Call Center",
    "slug": "operadores-call-center",
    "status": 1,
    "dateCreated": "2021-10-18 11:19:23",
    "dateUpdated": "2021-10-18 11:19:23",
    "authorId": 1
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Cadastrar Grupo
POST/afiliados-tipos/

Cadastra um novo grupo.

Example URI

POST /afiliados-tipos/
Request  Cadastrar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Body
{
  "name": "Operadores Call Center",
  "description": "Grupo dos Funcionários do Call Center",
  "slug": "operadores-call-center",
  "status": 1,
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "authorId": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome do Grupo de Afiliado"
    },
    "description": {
      "type": "string",
      "description": "Descrição para o grupo"
    },
    "slug": {
      "type": "string",
      "description": "Slug (referência interna)"
    },
    "status": {
      "type": "number",
      "description": "Status do Grupo"
    },
    "dateCreated": {
      "type": "string",
      "description": "timestamp"
    },
    "dateUpdated": {
      "type": "string",
      "description": "timestamp"
    },
    "authorId": {
      "type": "number",
      "description": "Qual usuário do sistema cadastrou este registro"
    }
  }
}
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
{
  "id": 10,
  "name": "Operadores Call Center",
  "description": "Grupo dos Funcionários do Call Center",
  "slug": "operadores-call-center",
  "status": 1,
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "authorId": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID interno"
    },
    "name": {
      "type": "string",
      "description": "Nome do Grupo de Afiliado"
    },
    "description": {
      "type": "string",
      "description": "Descrição para o grupo"
    },
    "slug": {
      "type": "string",
      "description": "Slug (referência interna)"
    },
    "status": {
      "type": "number",
      "description": "Status do Grupo"
    },
    "dateCreated": {
      "type": "string",
      "description": "timestamp"
    },
    "dateUpdated": {
      "type": "string",
      "description": "timestamp"
    },
    "authorId": {
      "type": "number",
      "description": "Qual usuário do sistema cadastrou este registro"
    }
  }
}

Atualizar Grupo
PUT/afiliados-tipos/{?id}

Atualiza um grupo existente.

Example URI

PUT /afiliados-tipos/?id=10
URI Parameters
HideShow
id
number (optional) Example: 10

ID interno

Request  Atualizar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Body
{
  "name": "Operadores Call Center",
  "description": "Grupo dos Funcionários do Call Center",
  "slug": "operadores-call-center",
  "status": 1,
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "authorId": 1
}
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
{
  "id": 10,
  "name": "Operadores Call Center",
  "description": "Grupo dos Funcionários do Call Center",
  "slug": "operadores-call-center",
  "status": 1,
  "dateCreated": "2021-10-18 11:19:23",
  "dateUpdated": "2021-10-18 11:19:23",
  "authorId": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID interno"
    },
    "name": {
      "type": "string",
      "description": "Nome do Grupo de Afiliado"
    },
    "description": {
      "type": "string",
      "description": "Descrição para o grupo"
    },
    "slug": {
      "type": "string",
      "description": "Slug (referência interna)"
    },
    "status": {
      "type": "number",
      "description": "Status do Grupo"
    },
    "dateCreated": {
      "type": "string",
      "description": "timestamp"
    },
    "dateUpdated": {
      "type": "string",
      "description": "timestamp"
    },
    "authorId": {
      "type": "number",
      "description": "Qual usuário do sistema cadastrou este registro"
    }
  }
}

Apagar Grupo
DELETE/afiliados-tipos/{?id}

Deleta um grupo de afiliado. Caso o grupo possua algum afiliado associado, não será possível excluí-lo. Para especificar qual afiliado deve ser excluído, utilize o parâmetro id

Example URI

DELETE /afiliados-tipos/?id=10
URI Parameters
HideShow
id
number (required) Example: 10

ID interno

Request  Apagar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
{
  "type": "success",
  "resultado": "Grupo excluído com sucesso"
}

Tags

tags

Lista as tags do sistema. Não é possível cadastrar ou alterar as tags através deste endpoint, pois a tag está atrelada ao afiliado. Para alterar uma tag, atualize o cadastro do afiliado.

Listar Tags
GET/tags/{?tag_name,tag_id}

Lista as tags cadastradas. É possível filtrar por qualquer campo.

Atenção!

O campo tag_id só estará disponível depois que a primeira doação for registrada usando a “tag_name” Enquanto não houver doações registradas, null será retornado. Utilize tag_id para consultas no Doação Solutions.

Example URI

GET /tags/?tag_name=MA12345&tag_id=689
URI Parameters
HideShow
tag_name
string (optional) Example: MA12345

Tag no formato AA00000 (2 letras e 5 números)

tag_id
number (optional) Example: 689

Id interna da Tag no Doação Solutions. Esta é a id que deve ser usada para consultas no DS.

Request  Listar
OcultarShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxx
Response  200
OcultarShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "tag_name": "MA12345",
    "tag_id": 20
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Desenvolvido por Hover Leads. Última atualização em 24 Jan 2022

Hover Leads