Inscrição API 2.0
Serviço destinado a criação de contas no Tiny.
Cabeçalhos
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| Developer-Id | string | obrigatório | Chave gerada para identificar a plataforma que enviou o request |
Conteúdo do body
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| dados_inscricao (1) | object | obrigatório | Dados da inscrição conforme layout |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| dados_inscricao | object | - | obrigatório | Elemento utilizado para representar uma inscrição |
| dados_inscricao.nome | string | - | obrigatório | Nome ou Razão Social |
| dados_inscricao.email | string | - | obrigatório | E-mail da conta |
| dados_inscricao.plano (1) | string | - | opcional | Identificador do plano da inscrição. |
| dados_inscricao.tipo (2) | string | - | obrigatório | Pessoa Física ou Jurídica |
| dados_inscricao.documento | string | - | obrigatório | CPF (Pessoa física) ou CNPJ (Pessoa jurídica) |
| dados_inscricao.apelido | string | - | obrigatório | Como o usuário deseja ser chamado |
| dados_inscricao.data_nascimento (3) | string | - | obrigatório (Pessoa Física) | Data de nascimento |
| dados_inscricao.codigo_promocional | string | - | opcional | Código promocional |
| dados_inscricao.canal_comunicacao (4) | list | - | obrigatório | Canal de Comunicação que usaremos para entrar em contato com você |
| dados_inscricao.celular | string | - | obrigatório | Telefone Celular |
(1) - Valores possíveis: 'Comecar', 'Crescer', 'Evoluir', 'Potencializar'. Caso não informado ou informado um plano inválido, será setado como padrão o 'Comecar'.
(2) - Valores possíveis: 'F' - Pessoa Física, 'J' - Pessoa Jurídica.
(3) - Esse campo deve ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(4) - Valores possíveis: '1' - E-mail, '2' - Celular.
Retorno do serviço
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | Elemento raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Conforme tabela Status de Processamento |
| retorno.status | string | - | obrigatório | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
| retorno.codigo_erro (1) | int | - | condicional | Conforme tabela Códigos de erro |
| retorno.erros[ ] (1) | list | - | condicional [0..n] | Contém a lista dos erros encontrados |
| retorno.erros[ ].erro (2) | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.erros[ ].campo | string | - | condicional | Nome do campo do body com problema(s) de validação |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Estes campos somente serão informados caso o retorno contenha erros.
