Api Docs Conecte.ai - V2

Introdução

Esses endpoints listam os provedores, planos e criam assinaturas. Todas as requisições precisam conter o header "origin" que informa os dados do provedor que será buscado.

Todos os endpoints que precisam de body precisam ser enviados em JSON, exceto o endpoint que realiza os uploads dos arquivos da assinatura, que necessita ser um Multipart/Form.

Listar todas as categorias de um provedor

[GET] /api/v2/providers/categories

Lista todas as categorias de um determinado provedor

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

{  "data": [    {      "id": "1",      "type": "categories",      "attributes": {        "nome": "Plano Pessoal",        "id": 1,        "ordenacao": null      }    },    {      "id": "2",      "type": "categories",      "attributes": {        "nome": "Plano Business",        "id": 2,        "ordenacao": null      }    }  ]}

Listar dados provedor

[GET] /api/v2/providers

Lista todas as informações de um provedor. O provedor precisa ser especificado na origin.

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

{  "data": {    "id": "3",    "type": "provedors",    "attributes": {      "nome": "jian net",      "cor_background_planos": "#3f89ff",      "cor_fonte_intro": "#3f89ff",      "cor_footer": "#3f89ff",      "cor_fonte_footer": "#3f89ff",      "wallpaper": "asasd",      "cor_navbar": "#3f89ff",      "logo": "eae",      "categories": [        {          "nome": "Plano Pessoal",          "id": 1,          "ordenacao": null,          "plans": [            {              "nome": "Plano 2",              "ordenacao": null,              "mensalidade_reais": 100,              "id": 210,              "mensalidade_centavos": "00",              "taxa_instalacao_a_vista": null,              "taxa_instalacao_parcelada": null,              "velocidade_upload": 0,              "velocidade_download": 150,              "mensalidade_observacao": null,              "detalhes_linha1": "Wifi Gratis",              "detalhes_linha2": "Instalação r",              "detalhes_linha3": null,              "cor_primaria": "#d18080",              "cor_secundaria": "#c4bec4",              "titulo": null,              "html": null,              "services": [],              "payment_methods": [                {                  "id": 1,                  "name": "Pix"                }              ]            },            {              "nome": "Plano 1",              "ordenacao": null,              "mensalidade_reais": 30,              "id": 1,              "mensalidade_centavos": "00",              "taxa_instalacao_a_vista": "100",              "taxa_instalacao_parcelada": "2x R$ 60,00",              "velocidade_upload": 200,              "velocidade_download": 100,              "mensalidade_observacao": null,              "detalhes_linha1": "teste",              "detalhes_linha2": "Instalação rápida",              "detalhes_linha3": "wi-fi gratis",              "cor_primaria": "#cc19cc",              "cor_secundaria": "#f7f7f7",              "titulo": null,              "html": null,              "services": [],              "payment_methods": [                {                  "id": 1,                  "name": "Pix"                }              ]            }          ]        },        {          "nome": "Plano Business",          "id": 2,          "ordenacao": null,          "plans": [            {              "nome": "Plano 2",              "ordenacao": null,              "mensalidade_reais": 100,              "id": 210,              "mensalidade_centavos": "00",              "taxa_instalacao_a_vista": null,              "taxa_instalacao_parcelada": null,              "velocidade_upload": 0,              "velocidade_download": 150,              "mensalidade_observacao": null,              "detalhes_linha1": "Wifi Gratis",              "detalhes_linha2": "Instalação r",              "detalhes_linha3": null,              "cor_primaria": "#d18080",              "cor_secundaria": "#c4bec4",              "titulo": null,              "html": null,              "services": [],              "payment_methods": [                {                  "id": 1,                  "name": "Pix"                }              ]            }          ]        }      ]    }  }}

Lista todos os planos de um provedor

[GET] /api/v2/providers/plans

Lista todos os planos com os metadados necessários

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

Status 200

{  "data": [    {      "id": "1",      "type": "planos",      "attributes": {        "nome": "Plano 1",        "ordenacao": null,        "mensalidade": "29.9",        "taxa_instalacao_a_vista": "100",        "taxa_instalacao_parcelada": "2x R$ 60,00",        "velocidade_upload": 0,        "velocidade_download": 0,        "mensalidade_observacao": null,        "detalhes_linha1": null,        "detalhes_linha2": null,        "detalhes_linha3": null,        "cor_primaria": null,        "cor_secundaria": null,        "titulo": null,        "html": null,        "services": [],        "payment_methods": [          {            "id": 1,            "name": "Pix"          }        ]      }    }  ]}

Lista todos os planos de um provedor

[GET] /api/v2/providers/check_coupon_availability

Checa se um cupom está disponível em um determinado plano, passando o plano como Id

Parâmetros

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
name	Nome do cupom	cupom-teste
plan_id	Id do plano para verificar o cupom	1

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

Status: 200

{  "data": {    "id": "14",    "type": "cupom",    "attributes": {      "description": "Deconto na mensalidade",      "id": 14,      "name": "Deconto na mensalidade"    }  }}

Status: 422

{  "errors": {    "coupon": "não encontrado"  }}

Cria uma nova assinatura

[POST] /api/v2/subscriptions

Cria uma assinatura e checa se existe cobertura do plano para o endereço informado.

Observação: O campo pre_subscription é necessário para que os dados da assinatura sejam salvos na base de dados

Parâmetros

Parâmetros necessários na requisição

Parâmetro	Descrição	Exemplo	Obs
plan_id	Id do plano para verificar o cupom	1	Opcional caso a opção cold lead esteja ativa
pre_subscription	Se é uma pre-inscrição	true
cold_lead	Se a inscrição é um lead frio, esse campo ativo permite inserir uma subscription somente com os campos telefone_celular e nome_razao_social	true

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Body

{  "plan_id": 1,  "subscription": {    "rua": "Av Anitta Garibald",    "cep": "82220-370",    "pre_subscription": true,    "provedor": "asdasdas",    "cold_lead": true,    "cidade": "Teste de cidade",    "coordinates": {      "lat": "-25.3587797",      "lng": "-49.2702625"    }  }}

Response

Status: 200

{  "data": {    "id": "35f6ebd8-79ac-42c5-b260-e10ff12a37a0",    "type": "subscriptions",    "attributes": {      "coverage": true    }  }}

Status: 422

{  "errors": {    "nome_razao_social": [      "texto muito curto"    ],    "telefone_celular": [      "formato deve ser '(XX) XXXX-XXXX'"    ]  }}

Atualizar uma assinatura

[PUT] /api/v2/subscriptions/:subscription_uuid

Atualiza os dados de uma assinatura utilizando o uuid na url.

Parâmetros

Parâmetros necessários na requisição

Parâmetro	Descrição	Exemplo
plan_id	Id do plano para verificar o cupom	1

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Body

{  "plan_id": 1,  "subscription": {    "rua": "asdasd",    "cep": "80420-120",    "provedor": "asdasdas",    "nome_razao_social": "Jian Rodrigues",    "email": "jian@gmail.com",    "telefone_celular": "(41) 99891-6002",    "forma_pagamentos_id": 1,    "vencimento": "dia 5",    "is_instalacao_a_vista": false,    "taxa_instalacao": "50",    "rg_ie": "500793839",    "cpf_cnpj": "45826486813",    "coupon_id": 1,    "cidade": "Teste de cidade",    "data_nascimento": "29/08/1998"  }}

Response

Status: 200

{  "data": {    "id": "35f6ebd8-79ac-42c5-b260-e10ff12a37a0",    "type": "subscriptions",    "attributes": {      "coverage": true    }  }}

Status: 422

{  "errors": {    "nome_razao_social": [      "texto muito curto"    ],    "telefone_celular": [      "formato deve ser '(XX) XXXX-XXXX'"    ]  }}

Upload de arquivos em uma assinatura

[POST] /api/v2/subscriptions/:subscription_uuid/files

Envia os arquivos necessários para uma assinatura (comprovante_rg, selfie e comprovante_res)

Observação: Essa requisição é do tipo Multipart/Form para que os arquivos possam ser enviados via binário e por consequência tenham um tamanho menor.

Parâmetros

Parâmetros necessários na requisição

Parâmetro	Descrição	Exemplo
plan_id	Id do plano para verificar o cupom	1
files[comprovante_res]	Arquivo com o comprovante de residência	[arquivo binário]
files[comprovante_rg]	Arquivo com o comprovante de RG	[arquivo binário]
files[selfie]	Arquivo com a selfie	[arquivo binário]

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Multipart	multipart/form-data

Response

Status: 200

{  "data": {    "id": "35f6ebd8-79ac-42c5-b260-e10ff12a37a0",    "type": "subscriptions",    "attributes": {      "coverage": true    }  }}

Status: 422

Api Docs Conecte.ai - V2

Introdução

Esses endpoints listam os provedores, planos e criam assinaturas. Todas as requisições precisam conter o header "origin" que informa os dados do provedor que será buscado.

Todos os endpoints que precisam de body precisam ser enviados em JSON, exceto o endpoint que realiza os uploads dos arquivos da assinatura, que necessita ser um Multipart/Form.

Listar todas as categorias de um provedor

[GET] /api/v2/providers/categories

Lista todas as categorias de um determinado provedor

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

{  "data": [    {      "id": "1",      "type": "categories",      "attributes": {        "nome": "Plano Pessoal",        "id": 1,        "ordenacao": null      }    },    {      "id": "2",      "type": "categories",      "attributes": {        "nome": "Plano Business",        "id": 2,        "ordenacao": null      }    }  ]}

Listar dados provedor

[GET] /api/v2/providers

Lista todas as informações de um provedor. O provedor precisa ser especificado na origin.

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

{  "data": {    "id": "3",    "type": "provedors",    "attributes": {      "nome": "jian net",      "cor_background_planos": "#3f89ff",      "cor_fonte_intro": "#3f89ff",      "cor_footer": "#3f89ff",      "cor_fonte_footer": "#3f89ff",      "wallpaper": "asasd",      "cor_navbar": "#3f89ff",      "logo": "eae",      "categories": [        {          "nome": "Plano Pessoal",          "id": 1,          "ordenacao": null,          "plans": [            {              "nome": "Plano 2",              "ordenacao": null,              "mensalidade_reais": 100,              "id": 210,              "mensalidade_centavos": "00",              "taxa_instalacao_a_vista": null,              "taxa_instalacao_parcelada": null,              "velocidade_upload": 0,              "velocidade_download": 150,              "mensalidade_observacao": null,              "detalhes_linha1": "Wifi Gratis",              "detalhes_linha2": "Instalação r",              "detalhes_linha3": null,              "cor_primaria": "#d18080",              "cor_secundaria": "#c4bec4",              "titulo": null,              "html": null,              "services": [],              "payment_methods": [                {                  "id": 1,                  "name": "Pix"                }              ]            },            {              "nome": "Plano 1",              "ordenacao": null,              "mensalidade_reais": 30,              "id": 1,              "mensalidade_centavos": "00",              "taxa_instalacao_a_vista": "100",              "taxa_instalacao_parcelada": "2x R$ 60,00",              "velocidade_upload": 200,              "velocidade_download": 100,              "mensalidade_observacao": null,              "detalhes_linha1": "teste",              "detalhes_linha2": "Instalação rápida",              "detalhes_linha3": "wi-fi gratis",              "cor_primaria": "#cc19cc",              "cor_secundaria": "#f7f7f7",              "titulo": null,              "html": null,              "services": [],              "payment_methods": [                {                  "id": 1,                  "name": "Pix"                }              ]            }          ]        },        {          "nome": "Plano Business",          "id": 2,          "ordenacao": null,          "plans": [            {              "nome": "Plano 2",              "ordenacao": null,              "mensalidade_reais": 100,              "id": 210,              "mensalidade_centavos": "00",              "taxa_instalacao_a_vista": null,              "taxa_instalacao_parcelada": null,              "velocidade_upload": 0,              "velocidade_download": 150,              "mensalidade_observacao": null,              "detalhes_linha1": "Wifi Gratis",              "detalhes_linha2": "Instalação r",              "detalhes_linha3": null,              "cor_primaria": "#d18080",              "cor_secundaria": "#c4bec4",              "titulo": null,              "html": null,              "services": [],              "payment_methods": [                {                  "id": 1,                  "name": "Pix"                }              ]            }          ]        }      ]    }  }}

Lista todos os planos de um provedor

[GET] /api/v2/providers/plans

Lista todos os planos com os metadados necessários

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

Status 200

{  "data": [    {      "id": "1",      "type": "planos",      "attributes": {        "nome": "Plano 1",        "ordenacao": null,        "mensalidade": "29.9",        "taxa_instalacao_a_vista": "100",        "taxa_instalacao_parcelada": "2x R$ 60,00",        "velocidade_upload": 0,        "velocidade_download": 0,        "mensalidade_observacao": null,        "detalhes_linha1": null,        "detalhes_linha2": null,        "detalhes_linha3": null,        "cor_primaria": null,        "cor_secundaria": null,        "titulo": null,        "html": null,        "services": [],        "payment_methods": [          {            "id": 1,            "name": "Pix"          }        ]      }    }  ]}

Lista todos os planos de um provedor

[GET] /api/v2/providers/check_coupon_availability

Checa se um cupom está disponível em um determinado plano, passando o plano como Id

Parâmetros

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
name	Nome do cupom	cupom-teste
plan_id	Id do plano para verificar o cupom	1

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição	http://conecte.ai.provedor
Content-Type	Json type	application/json

Response

Status: 200

{  "data": {    "id": "14",    "type": "cupom",    "attributes": {      "description": "Deconto na mensalidade",      "id": 14,      "name": "Deconto na mensalidade"    }  }}

Status: 422

{  "errors": {    "coupon": "não encontrado"  }}

Cria uma nova assinatura

[POST] /api/v2/subscriptions

Cria uma assinatura e checa se existe cobertura do plano para o endereço informado.

Observação: O campo pre_subscription é necessário para que os dados da assinatura sejam salvos na base de dados

Parâmetros

Parâmetros necessários na requisição

Parâmetro	Descrição	Exemplo	Obs
plan_id	Id do plano para verificar o cupom	1	Opcional caso a opção cold lead esteja ativa
pre_subscription	Se é uma pre-inscrição	true
cold_lead	Se a inscrição é um lead frio, esse campo ativo permite inserir uma subscription somente com os campos telefone_celular e nome_razao_social	true

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Body

{  "plan_id": 1,  "subscription": {    "rua": "Av Anitta Garibald",    "cep": "82220-370",    "pre_subscription": true,    "provedor": "asdasdas",    "cold_lead": true,    "cidade": "Teste de cidade",    "coordinates": {      "lat": "-25.3587797",      "lng": "-49.2702625"    }  }}

Response

Status: 200

{  "data": {    "id": "35f6ebd8-79ac-42c5-b260-e10ff12a37a0",    "type": "subscriptions",    "attributes": {      "coverage": true    }  }}

Status: 422

{  "errors": {    "nome_razao_social": [      "texto muito curto"    ],    "telefone_celular": [      "formato deve ser '(XX) XXXX-XXXX'"    ]  }}

Atualizar uma assinatura

[PUT] /api/v2/subscriptions/:subscription_uuid

Atualiza os dados de uma assinatura utilizando o uuid na url.

Parâmetros

Parâmetros necessários na requisição

Parâmetro	Descrição	Exemplo
plan_id	Id do plano para verificar o cupom	1

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Json type	application/json

Body

{  "plan_id": 1,  "subscription": {    "rua": "asdasd",    "cep": "80420-120",    "provedor": "asdasdas",    "nome_razao_social": "Jian Rodrigues",    "email": "jian@gmail.com",    "telefone_celular": "(41) 99891-6002",    "forma_pagamentos_id": 1,    "vencimento": "dia 5",    "is_instalacao_a_vista": false,    "taxa_instalacao": "50",    "rg_ie": "500793839",    "cpf_cnpj": "45826486813",    "coupon_id": 1,    "cidade": "Teste de cidade",    "data_nascimento": "29/08/1998"  }}

Response

Status: 200

{  "data": {    "id": "35f6ebd8-79ac-42c5-b260-e10ff12a37a0",    "type": "subscriptions",    "attributes": {      "coverage": true    }  }}

Status: 422

{  "errors": {    "nome_razao_social": [      "texto muito curto"    ],    "telefone_celular": [      "formato deve ser '(XX) XXXX-XXXX'"    ]  }}

Upload de arquivos em uma assinatura

[POST] /api/v2/subscriptions/:subscription_uuid/files

Envia os arquivos necessários para uma assinatura (comprovante_rg, selfie e comprovante_res)

Observação: Essa requisição é do tipo Multipart/Form para que os arquivos possam ser enviados via binário e por consequência tenham um tamanho menor.

Parâmetros

Parâmetros necessários na requisição

Parâmetro	Descrição	Exemplo
plan_id	Id do plano para verificar o cupom	1
files[comprovante_res]	Arquivo com o comprovante de residência	[arquivo binário]
files[comprovante_rg]	Arquivo com o comprovante de RG	[arquivo binário]
files[selfie]	Arquivo com a selfie	[arquivo binário]

Headers

Headers necessários para essa requisição

Parâmetro	Descrição	Exemplo
Origin	Origem da requisição (Precisa ser igual a URL do provedor)	http://conecte.ai.provedor
Content-Type	Multipart	multipart/form-data

Response

Status: 200

{  "data": {    "id": "35f6ebd8-79ac-42c5-b260-e10ff12a37a0",    "type": "subscriptions",    "attributes": {      "coverage": true    }  }}

Status: 422