Glossário
Existem vários conceitos que são ideias comuns e outros possuem um significado único no Connect Us Cloud.
| Nomenclatura | Descrição |
|---|---|
| API | Uma API (Application Programming Interface) é um conjunto de características e regras existentes em uma aplicação que possibilitam interações entre diferentes softwares. |
| Chamadas/Requisições | As requisições de API (Requests) são formas de fazer um software conversar com outro e permitir a troca de informações entre eles. Dessa forma, é possível integrar dados de diferentes plataformas, mesmo que não haja uma integração nativa no aplicativo. |
| Chave Estrangeira (FK) | De forma sucinta, a chave estrangeira, ou foreign key, é uma referência, em uma tabela, a uma chave primária de outra tabela. |
| Chave Primária (PK) | Também conhecida como primary key, essa chave é utilizada como o identificador único da tabela, sendo, então, representada, por aquele campo (ou campos) que não receberá valores repetidos. |
| Compressão de Dados | A Compressão é o ato de comprimir o envio e recebimento de dados, afim de reduzir o volume das informações trafegadas. |
| Computada | Colunas com valores gerados automaticamente pelo banco de dados, como auto-incremento ou datas automáticas. |
| Credenciais | Chaves criadas para proteger uma API, alterando seu status de Pública para Privada. |
| Endpoint | Um endpoint de um web service é a URL onde seu serviço pode ser acessado por uma aplicação cliente. |
| Endpoint Customizado | Um endpoint que permite configurar métodos e recursos individualmente, sem depender da API. |
| Filtros | Os filtros são utilizados para aprimorar a busca de resultados em um endpoint, podendo ser vinculado a uma credencial. |
| Formatação de Dados | Funcionalidade para criar uma "máscara" para customizar a exibição dos dados tanto na entrada (POST) quanto na saída (GET). |
| Gerenciador | É como nos referimos a plataforma de gerenciamento do ciclo de vida das APIs do Connect Us Cloud. |
| Host | Endereço onde o banco de dados está hospedado. |
| Link Externo | É um link de acesso externo contendo a documentação da sua API. É este link que você pode compartilhar com os consumidores de sua API. |
| Anulável | O Connect Us Cloud entente que um campo Anulável é opcional, não sendo necessário o envio de dados. |
| OAuth2 | OAuth2 é o protocolo que o Connect Us Cloud utiliza para autorização e autenticação. |
| OData | O Open Data Protocol é um protocolo aberto que permite a criação e o consumo de APIs REST consultáveis e interoperáveis de maneira simples e padrão. |
| Pacotes | Conjunto de produtos disponibilizados pelo Connect Us Cloud para aprimorar seu processo de criação e gerenciamento de APIs. |
| Produção | Significa que sua API está pronta para ser consumida por desenvolvedores e clientes, e está em ambiente de uso definitivo. |
| Testes (Sandbox) | Significa que sua API está em fase testes. O Connect Us Cloud limita a sua utilização porém permite ajustes significativos em sua estrutura base, durante esta etapa. |
| Recursos | Recursos é o nome dado para as tabelas de um banco de dados, pois são elas que fornecerão as informações para transmitir dados para a API. |
| Relacionamento | Funcionalidade do sistema que permite vincular tabelas através de relacionamentos, selecionando a PK e a FK entre duas tabelas. |
| String de Conexão | É um texto que passam as informações necessárias para o banco de dados estabelecer uma conexão com a aplicação. |
| Token | Uma chave utilizada para disponibilizar aos usuários a possibilidade de realizar chamadas a API. |
| URL | URL é a forma de identificar o endereço de um recurso em sua API. Exemplo: http://exemplo.gov/transparencia/v1/impostos |
| Versão (Versionar) | Versão ou versionar, é o ato de clonar (congelar) uma API já existente, e cria uma nova em uma versão diferente da atual. |