Especificar Detalhes da Ligação de Endpoint REST num Ficheiro JSON

Antes de criar uma ligação do Oracle Analytics Cloud para os endpoints REST de uma origem de dados, crie um ficheiro JSON comprimido que contenha os detalhes da ligação.

Pode descarregar um modelo JSON a partir de Biblioteca Pública do Oracle Analytics. Armazene os detalhes da ligação num ficheiro JSON baseado no modelo, em seguida, comprima o ficheiro JSON no formato ZIP. Também pode descarregar ficheiros JSON de exemplo para uma gama de aplicações SaaS e PaaS.

Formato do Modelo JSON para Ligação a Endpoints REST

{
    "name": "Connection name",
    "description": "Brief description",
    "baseURL": "URL, e.g. https://api.surveymonkey.com/v3",
    "endpoints": {
        "Endpoint 1": "Endpoint 1 URL, e.g. https://api.surveymonkey.com/v3/users/endpoint1",
        "Endpoint 2": "Endpoint 2 URL, e.g. https://api.surveymonkey.com/v3/question_bank/endpoint2",
        "Endpoint n": "Endpoint n URL, e.g. https://api.surveymonkey.com/v3/users/endpointn"
    },
    "authentication": {
        "type": "Authentication type"
    }
}

Exemplo JSON para Ligação a Endpoints REST de SurveyMonkey

{
    "name": "Survey Monkey Connection",
    "description": "Survey Monkey connection",
    "baseURL": "https://api.surveymonkey.com/v3",
    "endpoints": {
        "Users": "https://api.surveymonkey.com/v3/users/me",
        "Questions": "https://api.surveymonkey.com/v3/question_bank/questions"
    },
    "authentication": {
        "type": "HttpHeader"
    }
}

Acerca da Autenticação OAuth2

Antes de começar, certifique-se de que a sua origem de dados de destino suporta a autenticação OAuth2; nem todas as origens de dados suportam OAuth2.

Quando cria o ficheiro JSON utilizando um dos modelos descarregados, especifique o tipo de autenticação apropriado no campo authentication-type.

Tipos de OAuth2 Valores Válidos para o campo authentication-type.
Código de OAuth2 OAuth2Code
Credenciais da Senha de OAuth2 OAUTH2PasswordGrant
OAuth2 Implícito OAUTH2ImplicitGrant
Credenciais do Cliente de OAuth2 OAUTH2ClientCredentials

Neste exemplo, o método de autenticação Credenciais da Senha de OAuth2 é especificado utilizando "OAUTH2PasswordGrant" como o valor authentication-type.
Segue-se a descrição de GUID-4642572E-DC9E-4D96-BB92-73FBD9274BC3-default.png
.png

Outras sugestões sobre como criar o ficheiro JSON

  • Retire os parâmetros e os valores desnecessários do ficheiro.
  • Certifique-se de que o valor do tipo de autenticação está definido como noauth, BasicAuth, HttpHeader ou uma das definições de OAuth2 da tabela acima.