Pro Subscriber API (1.0.0)
Suporte API Pro Subscriber: contato@prosubscriber.com.br
Pro Subscriber API (1.0.0)
Suporte API Pro Subscriber: contato@prosubscriber.com.br
Autenticação
Basic Auth
| Security Scheme Type | HTTP |
| HTTP Authorization Scheme | basic |
BearerAuth
| Security Scheme Type | HTTP |
| HTTP Authorization Scheme | bearer |
| Bearer format | "AT" |
Integração com a Pro Subscriber
Esta API de Integração da Pro Subscriber está em desenvolvimento, podendo ficar instável ocasionalmente, contudo, está sendo construída com base em tecnologias atuais, visando principalmente padronização de acesso e segurança.
Restful
Utilizamos verbos do protocolo HTTP para identificar as operações que serão executadas, padronizamos a nomenclatura e as configurações de acesso dos recursos e retornamos um código de status HTTP condizentes com a resposta gerada.
Veja todos os HTTP status aqui.
Auth Token (AT)
Utilizamos tokens AT para controlar as permissões de acesso aos recursos da API.
Autenticação
Basic Auth
| Security Scheme Type | HTTP |
| HTTP Authorization Scheme | basic |
BearerAuth
| Security Scheme Type | HTTP |
| HTTP Authorization Scheme | bearer |
| Bearer format | "AT" |
Integração com a Pro Subscriber
Esta API de Integração da Pro Subscriber está em desenvolvimento, podendo ficar instável ocasionalmente, contudo, está sendo construída com base em tecnologias atuais, visando principalmente padronização de acesso e segurança.
Restful
Utilizamos verbos do protocolo HTTP para identificar as operações que serão executadas, padronizamos a nomenclatura e as configurações de acesso dos recursos e retornamos um código de status HTTP condizentes com a resposta gerada.
Veja todos os HTTP status aqui.
Auth Token (AT)
Utilizamos tokens AT para controlar as permissões de acesso aos recursos da API.
Componentes
Servidor de Recursos
É o componente onde os recursos de integração estão disponíveis.
Para obter acesso aos serviços recursos, você precisa:
- Criar uma conta Pro Subscriber no ambiente Staging . Sugerimos utilizar um cadastro oficial da pessoa ou da empresa que fará a integração. Pode-se também utilizar uma conta Pro Subscriber já existente.
- Com seu cadastro Staging completo, vá até a seção API e lá crie suas credenciais de acesso: token de autorização e client ID. O mesmo processo deve ser feito em produção em seguida.
Endpoints
| Ambiente | URL |
|---|---|
| Staging | https://prosubscriber-staging.herokuapp.com/api/v1/ |
| Produção | https://www.prosubscriber.com.br/api/v1/ |
Cada conta Pro Subscriber tem o seu próprio token de autorização e Client ID.
Para obter o token de autorização ou Client ID de uma conta Pro Subscriber já existente, o cliente precisa acessar o painel do cliente Pro Subscriber e realizar esta operação na aba API.
Componentes
Servidor de Recursos
É o componente onde os recursos de integração estão disponíveis.
Para obter acesso aos serviços recursos, você precisa:
- Criar uma conta Pro Subscriber no ambiente Staging . Sugerimos utilizar um cadastro oficial da pessoa ou da empresa que fará a integração. Pode-se também utilizar uma conta Pro Subscriber já existente.
- Com seu cadastro Staging completo, vá até a seção API e lá crie suas credenciais de acesso: token de autorização e client ID. O mesmo processo deve ser feito em produção em seguida.
Endpoints
| Ambiente | URL |
|---|---|
| Staging | https://prosubscriber-staging.herokuapp.com/api/v1/ |
| Produção | https://www.prosubscriber.com.br/api/v1/ |
Cada conta Pro Subscriber tem o seu próprio token de autorização e Client ID.
Para obter o token de autorização ou Client ID de uma conta Pro Subscriber já existente, o cliente precisa acessar o painel do cliente Pro Subscriber e realizar esta operação na aba API.
Sandbox
A Pro Subscriber disponibiliza um ambiente chamado Sandbox, para que você possa iniciar com segurança. É um ambiente dedicado e preparado para a homologação da sua integração. Ele existe justamente para que você consiga testar todos os recursos que irá utilizar na sua aplicação antes de virar a chave por completo para o ambiente de Produção.
Nesse ambiente, você poderá criar uma conta, testar, configurar e integrar o acesso aos recursos que desejar.
Você pode acessar a Sandbox clicando aqui aqui.
ATENÇÃO: O ambiente sandbox é um ambiente diferente do ambiente de produção, sendo necessário criar uma nova conta para acesso.
IMPORTANTE: Caso deseje utilizar o ambiente de Sandbox, fale conosco para que a gente configure seu ambiente individual.
Sandbox
A Pro Subscriber disponibiliza um ambiente chamado Sandbox, para que você possa iniciar com segurança. É um ambiente dedicado e preparado para a homologação da sua integração. Ele existe justamente para que você consiga testar todos os recursos que irá utilizar na sua aplicação antes de virar a chave por completo para o ambiente de Produção.
Nesse ambiente, você poderá criar uma conta, testar, configurar e integrar o acesso aos recursos que desejar.
Você pode acessar a Sandbox clicando aqui aqui.
ATENÇÃO: O ambiente sandbox é um ambiente diferente do ambiente de produção, sendo necessário criar uma nova conta para acesso.
IMPORTANTE: Caso deseje utilizar o ambiente de Sandbox, fale conosco para que a gente configure seu ambiente individual.
Código de Acesso
Este bloco destina-se a criação de um novo código de acesso.
Criar um código de acesso
Para a criação de um novo código de acesso, deve ser informado o seu Client ID (que foi criado juntamente com seu token de acesso), que fará a integração no parâmetro Client-ID.
HEADER PARAMETERS
token
required
string
Token de autenticação
Client-ID
required
integer
Client ID criado
REQUEST BODY SCHEMA: application/json;charset=UTF-8
planId
required
integer
ID do plano associado ao código de acesso que deseja criar.
codeType
required
string
Enum: "INDIVIDUAL" "GRUPO"
Tipo do código de acesso.
customPeriod
required
boolean
Enum: false true
Se customPeriod for false, o campo expiresAt será a data limite para utilização do código de acesso, e o bot tomará como data de expiração, a data de ativação do código + o número em dias do período do plano passado como parâmetro.
Se customPeriod for true, o bot removerá o assinante quando a data for igual a expiresAt.
startAt
required
date "yyyy-mm-dd"
Data de início do qual o código de acesso poderá ser utilizado.
expiresAt
required
date "yyyy-mm-dd"
Data de expiração do acesso quando customPeriod for igual a true, ou, date limite para utilização do código quando customPeriod for igual a false.
Responses
RESPONSE SCHEMA: application/json;charset=UTF-8
token
string
Código a ser utilizado pelo assinante.
status
string
Enum: "ACTIVE" "USED" "INACTIVE"
Status do código de acesso atual.
createdOn
string <date-time>
Data de criação do código de acesso.
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
Request samples
application/json;charset=UTF-8
{
"planId": "integer"
"codeType": "INDIVIDUAL"
"customPeriod": true
"startAt": "yyyy-mm-dd"
"expiresAt": "yyyy-mm-dd"
}
Response samples
application/json;charset=UTF-8
{
"token": "string"
"status": "ACTIVE"
"createdOn": "yyyy-mm-dd HH:mm:ss"
}
application/json;charset=UTF-8
{
"timestamp": "string"
"status": 0
"error": "string"
- "details: "
-
- "field": "optional"
- "message": "string"
- "errorCode": "string"
-
}
Código de Acesso
Este bloco destina-se a criação de um novo código de acesso.
Criar um código de acesso
Para a criação de um novo código de acesso, deve ser informado o seu Client ID (que foi criado juntamente com seu token de acesso), que fará a integração no parâmetro Client-ID.
HEADER PARAMETERS
token
required
string
Token de autenticação
Client-ID
required
integer
Client ID criado
REQUEST BODY SCHEMA: application/json;charset=UTF-8
planId
required
integer
ID do plano associado ao código de acesso que deseja criar.
codeType
required
string
Enum: "INDIVIDUAL" "GRUPO"
Tipo do código de acesso.
customPeriod
required
boolean
Enum: false true
Se customPeriod for false, o campo expiresAt será a data limite para utilização do código de acesso, e o bot tomará como data de expiração, a data de ativação do código + o número em dias do período do plano passado como parâmetro.
Se customPeriod for true, o bot removerá o assinante quando a data for igual a expiresAt.
startAt
required
date "yyyy-mm-dd"
Data de início do qual o código de acesso poderá ser utilizado.
expiresAt
required
date "yyyy-mm-dd"
Data de expiração do acesso quando customPeriod for igual a true, ou, date limite para utilização do código quando customPeriod for igual a false.
Responses
RESPONSE SCHEMA: application/json;charset=UTF-8
token
string
Código a ser utilizado pelo assinante.
status
string
Enum: "ACTIVE" "USED" "INACTIVE"
Status do código de acesso atual.
createdOn
string <date-time>
Data de criação do código de acesso.
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
RESPONSE SCHEMA: application/json;charset=UTF-8
timestamp
string
status
integer <int-32>
error
string
Array of objects (ErrorDetail)
Array ( ) [
field
optional
message
required
string
errorCode
required
string
]
Request samples
application/json;charset=UTF-8
{
"planId": "integer"
"codeType": "INDIVIDUAL"
"customPeriod": true
"startAt": "yyyy-mm-dd"
"expiresAt": "yyyy-mm-dd"
}
Response samples
application/json;charset=UTF-8
{
"token": "string"
"status": "ACTIVE"
"createdOn": "yyyy-mm-dd HH:mm:ss"
}
application/json;charset=UTF-8
{
"timestamp": "string"
"status": 0
"error": "string"
- "details: "
-
- "field": "optional"
- "message": "string"
- "errorCode": "string"
-
}
Sobre a Pro Subscriber
Somos a Pro Subscriber, uma plataforma que automatiza a sua gestão de assinaturas paga no Telegram de forma simplificada, segura e rápida.
Nosso objetivo é te dar tempo para focar no que realmente importa, um conteúdo de qualidade, e para isso, nós da Pro Subscriber cuidamos da gestão dos seus assinantes no Telegram de forma automatizada!
Somos uma empresa fruto da TECH 2P, especializada em Tecnologia Web e Mobile.
E como acreditamos que ninguém cresce sozinho, temos nossos parceiros de cobrança:
Sobre a Pro Subscriber
Somos a Pro Subscriber, uma plataforma que automatiza a sua gestão de assinaturas paga no Telegram de forma simplificada, segura e rápida.
Nosso objetivo é te dar tempo para focar no que realmente importa, um conteúdo de qualidade, e para isso, nós da Pro Subscriber cuidamos da gestão dos seus assinantes no Telegram de forma automatizada!
Somos uma empresa fruto da TECH 2P, especializada em Tecnologia Web e Mobile.
E como acreditamos que ninguém cresce sozinho, temos nossos parceiros de cobrança:
Autorizações
Primeiros Passos
Quais são os tokens usados e onde posso gerá-los?
Para ter acesso a API, é necessário entrar em contato conosco para a liberação desta funcionalidade através do e-mail 'contato@prosubscriber.com'. Temos dois tipos de tokens que são obrigatórios para uma requisição:
-
ClientID
Gerado na plataforma do ambiente correspondente na aba API. É um identificador do cliente realizando a requisição, necessário em todas as requisições da API, com o nome
Client-ID. -
Auth token/Bearer token
Gerado na plataforma do ambiente correspondente na aba API. ele é usado para autenticar todas as requisições da API, com o nome de
token.
Não encontrou a requisição que procura? Tem alguma dúvida, sugestão ou feedback? Entre em contato conosco através do e-mail: contato@prosubscriber.com.br
Autorizações
Primeiros Passos
Quais são os tokens usados e onde posso gerá-los?
Para ter acesso a API, é necessário entrar em contato conosco para a liberação desta funcionalidade através do e-mail 'contato@prosubscriber.com'. Temos dois tipos de tokens que são obrigatórios para uma requisição:
-
ClientID
Gerado na plataforma do ambiente correspondente na aba API. É um identificador do cliente realizando a requisição, necessário em todas as requisições da API, com o nome
Client-ID. -
Auth token/Bearer token
Gerado na plataforma do ambiente correspondente na aba API. ele é usado para autenticar todas as requisições da API, com o nome de
token.