Autenticazione di base

L’autenticazione di base è un tipo di autenticazione che ti consente di accedere all’applicazione utilizzando una combinazione del nome utente dell’account e della password dell’account.

Visualizza esempio di autenticazione di base
{
  "name": "Basic Authentication",
  "type": "BasicAuthentication",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "defines auth params required for connecting to rest service.",
    "properties": {
      "username": {
        "description": "Username to connect rest endpoint.",
        "type": "string"
      },
      "password": {
        "description": "Password to connect rest endpoint.",
        "type": "string",
        "format": "password"
      }
    },
    "required": [
      "username",
      "password"
    ]
  }
}
ProprietàDescrizioneEsempio
authSpec.nameVisualizza il nome del tipo di autenticazione supportato.Basic Authentication
authSpec.typeDefinisce il tipo di autenticazione supportato dall'origine.BasicAuthentication
authSpec.specContiene informazioni sullo schema, il tipo di dati e le proprietà dell’autenticazione.
authSpec.spec.$schemaDefinisce lo schema utilizzato per l’autenticazione.http://json-schema.org/draft-07/schema#
authSpec.spec.typeDefinisce il tipo di dati dello schema.object
authSpec.spec.descriptionVisualizza ulteriori informazioni specifiche per il tipo di autenticazione.
authSpec.spec.propertiesContiene informazioni sulle credenziali utilizzate per l’autenticazione.
authSpec.spec.properties.usernameIl nome utente dell’account associato all’applicazione.
authSpec.spec.properties.passwordLa password dell'account associata all'applicazione.
authSpec.spec.requiredSpecifica i campi obbligatori come valori obbligatori da immettere in Experience Platform.username

Autenticazione chiave API

L’autenticazione tramite chiave API è un metodo sicuro per accedere alle API, fornendo una chiave API e altri parametri di autenticazione rilevanti nelle richieste. A seconda delle informazioni API specifiche, puoi inviare la chiave API come parte dell’intestazione della richiesta, dei parametri della query o del corpo.

I seguenti parametri sono generalmente necessari quando si utilizza l’autenticazione con chiave API:

ParametroTipoObbligatorioDescrizione
hoststringaNoURL della risorsa.
authKey1stringaLa prima chiave di autenticazione necessaria per l’accesso API. In genere viene inviato nell’intestazione della richiesta o nei parametri di query.
authKey2stringaFacoltativoUna seconda chiave di autenticazione. Se necessario, questo sistema operativo chiave viene spesso utilizzato per convalidare ulteriormente le richieste.
authKeyNstringaFacoltativoVariabile di autenticazione aggiuntiva che può essere utilizzata in base alle esigenze, ma con l’API.
Autenticazione chiave API View
{
  "name": "API Key Authentication",
  "type": "KeyBased",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "Define authentication parameters required for API access",
    "properties": {
      "host": {
        "type": "string",
        "description": "Enter resource URL host path"
      },
      "authKey1": {
        "type": "string",
        "format": "password",
        "title": "Authentication Key 1",
        "description": "Primary authentication key for accessing the API",
        "restAttributes": {
          "headerParamName": "X-Auth-Key1"
        }
      },
      "authKey2": {
        "type": "string",
        "format": "password",
        "title": "Authentication Key 2",
        "description": "Secondary authentication key, if required",
        "restAttributes": {
          "headerParamName": "X-Auth-Key2"
        }
      },
      ..
      ..
      "authKeyN": {
        "type": "string",
        "format": "password",
        "title": "Additional Authentication Key",
        "description": "Additional authentication keys as needed by the API",
        "restAttributes": {
          "headerParamName": "X-Auth-KeyN"
        }
      }
    },
    "required": [
      "authKey1"
    ]
  }
}