Documentação e Cronograma - Cia do Click

Para acesso ao cronograma utilize o link: CRONOGRAMA DETALHADO

Para acesso a Documentação da API: API CIA DO CLICK POSTMAN para fazer o login e ter acesso a todos os testes e amostras de código, faça login usando o Google com o email da companhiadoclick@gmail.com

Para fazer o download do modelo para o Postman JSON Cia Do Click - Postman - JSON

Programas usados

Para fazer o download do POSTMAN e instalar em seu computador utilize: postman.com e siga as instruções conforme o sistema opercional

Software para Cronograma e Gráfico de Gantt - Planner: wiki.gnome.org/Apps/Planner

Links Úteis

Api Cia do click - api.ciadoclick.com.br

Autenticação de Usuários - auth.ciadoclick.com.br

Manipulador de Imagens - imagem.ciadoclick.com.br

Site App - ciadoclick.com.br

TESTE PLATAFORMA UOL - teste.ciadoclick.com.br

FRONT REDE SOCIAL - gestao.ciadoclick.com.br

Guia de Estilo

Para garantir a qualidade do código e a interoperabilidade, ao desenvolver um código para uso na plataforme, procure seguir ao máximo as regras de nomenclatura de Classes e Objetos, variáveis de memória, nomes de funções e hierarquias, bem como evitar o uso de atalhos ou abreviações.
Todos os códigos são aderentes ao PSR-1, PSR-2 e PSR-4. Para a troca de mensagens entre os processos, utilizamos em todas as chamadas de recurso (URI) nas requisições (REQUEST) o formato de recebimento via X-WWW-FORM-URLENCODED que é usado pelos navegadores web, javascript HttpRequest, JQuery, Curl, entre outras ferramentas e linguagens diversas.
Para as respostas (RESPONSES) utilizamos o formato JSON (JavaScript Object Notation) e em casos onde seja necessária a troca de conteúdos binários como arquivos, imagens, vídeos e códigos o codificador BASE64 que também é amplamente suportado por diversas linguagens.
Todo o ambiente de BackEnd possui suporte as bibliotecas do Composer Composer PHP Pacage Manager e utilizamos para a nomenclatura al seguintes regras:
- Nomes de Campos de Mensageria: Usamos o padrão CamelCase e nomes em Portugues sem acentuação.
- Nomes de Campos Bancos de Dados: snake_case com nometabela_campo_completo, para troca de dados entre sistema e banco de dados, usamos um array com as chaves compartilhando o nome do campo. Para conteúdos filhos, usamos array multidimensional.
- Nome de Funções: utilizando namespaces, conforme o PSR-1, os nomes de funções são feitas usando dromedaryCase()
- Nomes de Variaveis: evitar o uso de variáveis Globais e passagem por referencia ou fora de escopo, e não utilizar persistência de variáveis em Objetos ou Sessões ou mesmo em disco, pois o projeto preve uso de multiplos servidores. Ao desenvolver uma instância, siga as boas práticas de Design Patterns.