Określanie szczegółów połączenia z punktem końcowym REST w pliku JSON

Przed przystąpieniem do tworzenia połączenia z Oracle Analytics Cloud do punktów końcowych REST źródła danych należy utworzyć plik JSON zawierający szczegóły połączenia i spakować go do pliku.

Szablon JSON można także pobrać ze strony Oracle Analytics - biblioteka publiczna. Szczegóły połączenia należy zawrzeć w pliku JSON opartym na szablonie, a następnie należy skompresować plik JSON do pliku w formacie ZIP. Można także pobrać przykładowe pliki JSON dla różnych aplikacji SaaS i PaaS.

Format szablonu JSON dla połączenia z punktami końcowymi 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"
    }
}

Przykład pliku JSON dla połączenia z punktami końcowymi REST serwisu Survey Monkey

{
    "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"
    }
}

Identyfikacja OAuth2 - informacje podstawowe

Przed rozpoczęciem należy się upewnić, że docelowe źródło danych obsługuje identyfikację OAuth2 - nie wszystkie źródła danych obsługują protokół OAuth2.

Podczas tworzenia pliku JSON z użyciem jednego z pobranych szablonów należy określić właściwy typ identyfikacji w polu authentication-type.

Typy identyfikacji OAuth2 Poprawne wartości w polu "authentication-type"
Kod OAuth2 OAuth2Code
Uwierzytelnienia: hasło OAuth2 OAUTH2PasswordGrant
OAuth2: jawne OAUTH2ImplicitGrant
Uwierzytelnienia klienta OAuth2 OAUTH2ClientCredentials

W tym przykładzie określono metodę identyfikacji "Uwierzytelnienia: hasło OAuth2", używając wartości "OAUTH2PasswordGrant" w polu authentication-type.
Opis "GUID-4642572E-DC9E-4D96-BB92-73FBD9274BC3-default.png" znajduje się poniżej
.png"

Inne wskazówki dotyczące tworzenia pliku JSON

  • Z pliku należy usunąć niepotrzebne parametry i wartości.
  • Należy się upewnić, że wartość w polu "authentication-type" to "noauth", "BasicAuth", "HttpHeader" lub jedna z wartości wymieniona w powyższej tabeli z ustawieniami OAuth2.