Show Menu
TÓPICOS×

Criar um Couchbase conector usando a Flow Service API

O Couchbase conector está em beta. Consulte a visão geral das Fontes para obter mais informações sobre o uso de conectores com rótulo beta.
Flow Service é usada para coletar e centralizar dados do cliente de várias fontes diferentes para inserir o Adobe Experience Platform. O serviço fornece uma interface de usuário e uma RESTful API a partir da qual todas as fontes compatíveis são conectáveis.
Este tutorial usa a API de Serviço de Fluxo para guiá-lo pelas etapas para se conectar Couchbase a Experience Platform.

Introdução

Este guia exige uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:
  • Fontes : Experience Platform permite que os dados sejam ingeridos de várias fontes e, ao mesmo tempo, fornece a você a capacidade de estruturar, rotular e aprimorar os dados recebidos usando Platform serviços.
  • Caixas de proteção : Experience Platform fornece caixas de proteção virtuais que particionam uma única Platform instância em ambientes virtuais separados para ajudar a desenvolver e desenvolver aplicativos de experiência digital.
As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito Couchbase usando a Flow Service API.

Reunir credenciais obrigatórias

Credencial
Descrição
connectionString
A cadeia de conexão usada para se conectar à sua Couchbase instância. O padrão da string de conexão para Couchbase é Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; . Para obter mais informações sobre como adquirir uma string de conexão, consulte este documento Couchbase.
connectionSpec.id
O identificador necessário para criar uma conexão. A ID de especificação de conexão fixa para Couchbase é 1fe283f6-9bec-11ea-bb37-0242ac130002 .

Lendo chamadas de exemplo da API

Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de amostra retornado em respostas de API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de amostra, consulte a seção sobre como ler chamadas de API de exemplo no guia de Experience Platform solução de problemas.

Reunir valores para cabeçalhos necessários

Para fazer chamadas para Platform APIs, você deve primeiro concluir o tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de Experience Platform API, como mostrado abaixo:
  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Todos os recursos em Experience Platform, incluindo os pertencentes a Flow Service, são isolados para caixas de proteção virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da caixa de proteção em que a operação ocorrerá:
  • x-sandbox-name: {SANDBOX_NAME}
Todas as solicitações que contêm uma carga (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:
  • Tipo de conteúdo: application/json

Criar uma conexão

Uma conexão especifica uma fonte e contém suas credenciais para essa fonte. Somente um conector é necessário por Couchbase conta, pois pode ser usado para criar vários conectores de origem para trazer dados diferentes.
Formato da API
POST /connections

Solicitação
A solicitação a seguir cria uma nova Couchbase conexão, configurada pelas propriedades fornecidas na carga:.
curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Couchbase test connection",
        "description": "A test connection for a Couchbase source",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                    "connectionString": "Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];"
                }
        },
        "connectionSpec": {
            "id": "1fe283f6-9bec-11ea-bb37-0242ac130002",
            "version": "1.0"
        }
    }'

Propriedade
Descrição
auth.params.connectionString
A cadeia de conexão usada para conectar-se a uma Couchbase conta. O padrão da string de conexão é: Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; .
connectionSpec.id
A ID de especificação da Couchbase conexão: 1fe283f6-9bec-11ea-bb37-0242ac130002 .
Resposta
Uma resposta bem-sucedida retorna os detalhes da conexão recém-criada, incluindo seu identificador exclusivo ( id ). Essa ID é necessária para explorar seus dados no próximo tutorial.
{
    "id": "54997109-07b5-40b7-9971-0907b5a0b75a",
    "etag": "\"280168f5-0000-0200-0000-5ed72b230000\""
}

Próximas etapas

Ao seguir este tutorial, você criou uma Couchbase conexão usando a Flow Service API e obteve o valor de ID exclusivo da conexão. Você pode usar essa ID no próximo tutorial à medida que aprende a explorar bancos de dados usando a API do Serviço de Fluxo.