Conexão a serviços de dados REST

O identificador uniforme de recurso (URI) ou o caminho absoluto do arquivo do recurso RESTful.

O esquema usado para autenticação. Os tipos de autenticação disponíveis são os seguintes:

• Sem Autenticação O driver não usa nenhuma autenticação.
• Chave de API O driver utiliza chave de API para autenticação.
• Token do Portador O driver usa um token do portador para autenticação.
• Autenticação básica O driver usa autenticação básica com nome de usuário e senha.
• OAuth 1.0 O driver utiliza OAuth 1.0 para autenticação.
• OAuth 2.0 O driver utiliza OAuth 2.0 para autenticação.

Especifica a chave de API para autenticação.

Esse campo somente é ativado quando Chave de API é selecionado no campo Tipo de Autorização.

O valor neste campo é usado com a Chave de API fornecida para autenticação no servidor.

Esse campo somente é ativado quando Chave de API é selecionado no campo Tipo de Autorização.

Especifica o token do portador para autenticação no servidor. O token pode ser uma chave de acesso, como um token web JSON (JWT) que está incluído no cabeçalho da solicitação.

Esse campo somente é ativado quando Token do Portador é selecionado no campo Tipo de Autorização.

O nome de usuário que será usado para se conectar a uma origem de dados REST.

Esse campo somente é ativado quando Autenticação Básica é selecionado no campo Tipo de Autorização.

A senha para o nome do usuário para se conectar a uma origem de dados REST.

Esse campo somente é ativado quando Autenticação Básica é selecionado no campo Tipo de Autorização.

O tipo de concessão para o fluxo do OAuth. As opções disponíveis são as seguintes:

• CODE

• CLIENT

• PASSWORD

Essa propriedade pode ser definida para uma cadeia de cabeçalhos HTTP a ser anexada aos cabeçalhos de solicitação HTTP criados a partir de outras propriedades, como Content-Type, From e assim por diante.

Os cabeçalhos devem estar no formato "cabeçalho: valor", conforme descrito nas especificações do HTTP. Cada cabeçalho deve estar em sua própria linha.

Utilize esta opção com cuidado. Cabeçalhos inválidos podem causar falha nas solicitações HTTP. Essa propriedade é útil para ajustes na integração com APIs especializadas ou não padrão.

Content-Type: text/html; charset=utf-8

Connection: keep-alive

Propriedades ocultas necessárias apenas em casos de uso específicos. Normalmente, você não precisa especificar nada aqui. Especifique várias propriedades em uma lista separada por ponto-e-vírgula.

Configuração do armazenamento em cache

• CachePartial=True Armazena em cache apenas um subconjunto de colunas, que você pode especificar na consulta.
• QueryPassthrough=True Passa a consulta especificada para a base de dados do cache, em vez de utilizar o analisador SQL do driver.

Integração e formatação

• SupportAccessLinkedMode No modo vinculado do Access, geralmente é uma boa ideia usar sempre um cache, já que a maioria das origens de dados não permite consultas com vários IDs. No entanto, se você quiser usar o driver no Access, mas não no modo vinculado, essa propriedade deve ser definida como False para evitar usar um cache de uma consulta SELECT * para a tabela informada.
• DefaultColumnSize Define o comprimento padrão dos campos de cadeia quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000.
• ConvertDateTimeToGMT Especifica se os valores de data-hora devem ser convertidos para GMT (UTC), em vez da hora local da máquina.
• RecordToFile=nome_arquivo Regista a transferência de dados do soquete subjacente para o arquivo especificado.

Propriedades do OAuth

• InitiateOAuth Defina essa propriedade para iniciar o processo de obtenção ou atualização do token de acesso do OAuth quando você se conectar. Os seguintes opções estão disponíveis:

  • OFF Indica que você tratará integralmente o fluxo do OAuth. Um OAuthAccessToken será necessário para autenticar.

  • GETANDREFRESH Indica que todo o fluxo de OAuth será tratado pelo driver. Se nenhum token existir no momento, você deverá fornecê-lo em uma solicitação do navegador. Se um token existir, será atualizado quando aplicável.

  • REFRESH Indica que o driver tratará apenas a atualização do OAuthAccessToken. O driver nunca solicitará que você se autentique pelo navegador. Você deve tratar inicialmente a obtenção do OAuthAccessToken e do OAuthRefreshToken.

• Local do OAuthSettingsLocation A localização do arquivo de configurações onde os valores de OAuth são salvos quando InitiateOAuth é definido como verdadeiro. Quando InitiateOAuth está ativado, o driver salva os valores de OAuth em um arquivo de configurações para evitar que o usuário tenha de inserir manualmente as propriedades da conexão do OAuth. Quando a sessão do OAuth expirar, se InitiateOAuth estiver definido, o driver obterá automaticamente um novo token de acesso. Se InitiateOAuth estiver ativado, mas OAuthSettingsLocation não estiver definido, o driver usará um arquivo de configurações padrão, %AppData%\CData\REST Data Provider\OAuthSettings.txt no Windows. No macOS, esse arquivo está localizado em ~/Library/Application Support/CData/REST Data Provider/OAuthSettings.txt. No Linux, ~/cdata/.config.

• OAuthAcccessToken O OAuthAccessToken é recuperado do servidor do OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre solicitações. O Token de acesso é usado em vez do nome de usuário e da senha. O token de acesso protege as credenciais, mantendo-as no servidor.

• OAuthAccessTokenSecret O OAuthAccessTokenSecret é recuperado do servidor do OAuth como parte do processo de autenticação. Ele é usado com o OAuthAccessToken e pode ser utilizado para várias solicitações até esgotar seu tempo limite.

• OAuthRefreshToken A propriedade OAuthRefreshToken é usada para atualizar OAuthAccessToken quando a autenticação do OAuth é usada.

Especifica o modelo de dados a ser usado na análise de documentos JSON ou XML e na geração dos metadados.

• Document Será retornada uma única tabela representando uma linha por documento. Nesse modelo de dados, documentos aninhados (matrizes de objetos) serão nivelados e retornados como agregados. A menos que um valor de XPath seja especificado explicitamente, o driver identificará e usará como XPath o documento mais superior (matriz de objetos) encontrado.
• FlattenedDocuments Será retornada uma única tabela representando um JOIN dos documentos disponíveis no arquivo JSON ou XML. Nesse modelo de dados, valores XPath aninhados atuarão da mesma forma que um SQL JOIN. Além disso, os valores XPath de irmãos aninhados (caminhos filhos na mesma altura) serão tratados como um SQL CROSS JOIN. A menos que explicitamente especificado, o driver identificará os valores XPath disponíveis analisando o arquivo JSON ou XML e identificando os documentos disponíveis (incluindo documentos aninhados).
• Relational Várias tabelas serão retornadas, uma para cada valor XPath especificado. Nesse modelo de dados, documentos aninhados (matrizes de objetos) serão retornados como tabelas relacionais com chaves primárias e estrangeiras. A menos que explicitamente especificado, o driver identificará os valores XPath disponíveis analisando o arquivo JSON ou XML e identificando os documentos disponíveis (incluindo documentos aninhados).

Por padrão, matrizes aninhadas são retornadas como cadeias de JSON ou XML. A propriedade FlattenArrays pode ser usada para nivelar os elementos de matrizes aninhadas em colunas próprias. Defina FlattenArrays como o número de elementos que você deseja retornar das matrizes aninhadas.

A configuração de FlattenArrays como -1 nivelará todos os elementos das matrizes aninhadas.

Especifica se um arquivo de esquema (RSD) será gerado a partir do documento analisado.

• Never Um arquivo de esquema (RSD) nunca será gerado.
• OnUse Se o arquivo de esquema (RSD) não existir, será gerado na primeira vez que uma tabela for referenciada.
• OnStart Um arquivo de esquema (RSD) será gerado no momento da conexão para todas as tabelas que não têm um arquivo de esquema (RSD).

Essa propriedade é usada em conjunto com Format, URI, XPath e Location.

O XPath de um elemento repetido na mesma altura dentro de um documento XML/JSON (usado para dividir o documento em várias linhas).

Vários caminhos podem ser especificados usando uma lista separada ponto e vírgula. A definição DataModel permite configurar como os valores XPath serão usados para criar tabelas e exibir dados.

O número de linhas a serem verificadas na determinação dinâmica das colunas para a tabela. As colunas são determinadas dinamicamente quando um arquivo de esquema (RSD) não está disponível para a tabela, como ao usar GenerateSchemaFiles. Valores mais altos resultarão em uma solicitação mais longa, mas serão mais precisos.

A definição desse valor como 0 (zero) analisará todo o documento.

Para uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não tenha uma relação de confiança com a máquina será rejeitado.

Se não especificado, qualquer certificado confiável para a máquina será aceito.

Use '*' para aceitar todos os certificados (não recomendado por motivos de segurança).

• -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
• C:\cert.cer
• -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
• ecadbdda5a1529c58a1e9e09828d70e4
• 34a929226ae0819f2ec14b4a3d904f801cbb150d

O comprimento máximo de uma coluna de chave primária.

Em algumas ferramentas de ODBC, o comprimento da coluna da chave primária não pode ser maior do que um valor específico. Essa propriedade faz com que o driver ODBC ignore o comprimento relatado para todas as colunas de chave primária. Ela é particularmente útil na utilização do driver ODBC como uma fonte de dados vinculada do Microsoft Access.

A definição de LimitKeySize como zero retornará o comprimento da chave para o valor original.

Essa propriedade controla se uma coluna é retornada como SQL_LONGVARCHAR.

Alguns aplicativos exigem que todos os dados de texto maiores que um determinado número de caracteres sejam relatados como SQL_LONGVARCHAR. Use essa propriedade para mapear todas as colunas maiores que o tamanho especificado para que sejam relatadas como SQL_LONGVARCHAR em vez de SQL_VARCHAR.

Indica se pseudocolunas devem ou não ser incluídas como colunas na tabela.

Essa configuração é particularmente útil no Entity Framework, que não permite a definição de um valor para uma pseudocoluna a menos que seja uma coluna de tabela.

Você pode usar um caractere de asterisco "*" para incluir todas as tabelas e todas as colunas. Por exemplo: *=*.

Table1=Column1, Table1=Column2, Table2=Column3

Esse valor especifica o tipo de autenticação usado para autenticar no proxy HTTP especificado por ProxyServer e ProxyPort.

Por padrão, o driver usa as configurações do proxy de sistema, sem necessidade de configurações adicionais. Se você quiser conectar-se a outro proxy, será necessário definir ProxyAutoDetect como falso, além de ProxyServer e ProxyPort. Para autenticar, defina ProxyAuthScheme e, se necessário, ProxyUser e ProxyPassword.

O tipo de autenticação pode ser um dos seguintes:

• BASIC O driver executa a autenticação HTTP BASIC.
• DIGEST O driver executa a autenticação HTTP DIGEST.
• NENHUM
• NEGOTIATE O driver recupera um token NTLM ou Kerberos de acordo com o protocolo aplicável para autenticação.
• NTLM
• PROPRIETARY O driver não gera um token NTLM ou Kerberos. Você deve fornecer esse token no cabeçalho de autorização da solicitação HTTP.

O tipo de SSL usado para conexão ao proxy ProxyServer.

• AUTO Configuração padrão. Se o URL for um URL HTTPS, o conector usará a opção TUNNEL. Se o URL for um URL HTTP, o componente usará a opção NEVER.
• ALWAYS A conexão terá sempre o SSL ativado.
• NEVER A conexão não tem o SSL ativado.
• TUNNEL A conexão é feita por meio de um proxy de túnel. O servidor do proxy abre uma conexão para o host remoto e o tráfego vai e volta pelo proxy.

Uma lista separada por ponto e vírgula de hosts ou IPs que estarão isentos de conexão por meio do ProxyServer.

Por padrão, o conector usa as configurações do proxy de sistema, sem necessidade de configurações adicionais. Se você quiser configurar explicitamente exceções de proxy para essa conexão, será necessário definir ProxyAutoDetect como falso e configurar ProxyServer e ProxyPort. Para autenticar, defina ProxyAuthScheme e, se necessário, ProxyUser e ProxyPassword.