Flow Service é usada para coletar e centralizar dados do cliente de várias fontes diferentes no 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 Flow Service API para explorar os sistemas de sucesso do cliente (CS).
Este guia exige uma compreensão prática dos seguintes componentes do Adobe Experience Platform:
As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito a um sistema CS usando a Flow Service API.
Para explorar seu sistema CS usando Platform APIs, é necessário ter uma ID de conexão básica válida. Se você ainda não tiver uma conexão básica para o sistema CS que deseja trabalhar, poderá criar uma através dos seguintes tutoriais:
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.
Para fazer chamadas para Platform APIs, você deve primeiro concluir o tutorial deautenticaçã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:
{ACCESS_TOKEN}
{API_KEY}
{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á:
{SANDBOX_NAME}
Todas as solicitações que contêm uma carga (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:
application/json
Usando a conexão básica para seu sistema CS, você pode explorar suas tabelas de dados realizando solicitações de GET. Use a chamada a seguir para localizar o caminho da tabela na qual você deseja inspecionar ou assimilar Platform.
Formato da API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parâmetro | Descrição |
---|---|
{BASE_CONNECTION_ID} |
A ID de uma conexão básica do CS. |
Solicitação
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/60a5c8b9-3c30-43ba-a5c8-b93c3093ba66/explore?objectType=root' \
-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}'
Resposta
Uma resposta bem-sucedida retorna uma matriz de tabelas do sistema CS. Encontre a tabela que deseja trazer Platform e anote sua path
propriedade, pois é necessário fornecê-la na próxima etapa para inspecionar sua estrutura.
[
{
"type": "table",
"name": "Accepted Event Relation",
"path": "AcceptedEventRelation",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Account",
"path": "Account",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Account Change Event",
"path": "AccountChangeEvent",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Account Clean Info",
"path": "AccountCleanInfo",
"canPreview": true,
"canFetchSchema": true
}
]
Para inspecionar a estrutura de uma tabela do sistema CS, execute uma solicitação de GET enquanto especifica o caminho de uma tabela como parâmetro de query.
Formato da API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parâmetro | Descrição |
---|---|
{BASE_CONNECTION_ID} |
A ID de uma conexão básica do CS. |
{TABLE_PATH} |
O caminho de uma tabela. |
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/60a5c8b9-3c30-43ba-a5c8-b93c3093ba66/explore?objectType=table&object=test1.Mytable' \
-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}'
Resposta
Uma resposta bem-sucedida retorna a estrutura da tabela especificada. Os detalhes referentes a cada coluna da tabela estão localizados em elementos da columns
matriz.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Id",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Name",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Phone",
"type": "string",
"xdm": {
"type": "string"
}
},
]
}
}
Ao seguir este tutorial, você explorou seu sistema CS, encontrou o caminho da tabela na qual deseja assimilar Platforme obteve informações sobre sua estrutura. Você pode usar essas informações no próximo tutorial para coletar dados do sistema CS e trazê-los para a Plataforma.