Flow Service O é usado 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 a API RESTful a partir da qual todas as fontes compatíveis são conectáveis.
Este tutorial usa o Flow Service API para explorar aplicativos de pagamento.
Este guia requer uma compreensão funcional 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 uma aplicação de pagamentos usando o Flow Service API.
Este tutorial requer que você tenha uma conexão válida com o aplicativo de pagamentos de terceiros do qual deseja assimilar dados. Uma conexão válida envolve a ID da especificação de conexão do aplicativo e a ID da conexão. Mais informações sobre como criar uma conexão de pagamentos e recuperar esses valores podem ser encontradas na seção conectar uma origem de pagamentos à Platform tutorial.
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 exemplo de JSON retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no Experience Platform guia de solução de problemas.
Para fazer chamadas para Platform APIs, primeiro conclua o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todos os Experience Platform Chamadas de API, conforme mostrado abaixo:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Todos os recursos em Experience Platform, incluindo as que pertencem a Flow Service, são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox 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 ID de conexão para seu sistema de pagamentos, você pode explorar suas tabelas de dados executando solicitações GET. Use a chamada a seguir para encontrar o caminho da tabela que 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 da base de pagamentos. |
Solicitação
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/24151d58-ffa7-4960-951d-58ffa7396097/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna uma matriz de tabelas do seu sistema de pagamentos. Encontre a tabela que deseja trazer para Platform e toma nota da sua path
propriedade, conforme necessário fornecê-la na próxima etapa para inspecionar sua estrutura.
[
{
"type": "table",
"name": "PayPal.Billing_Plans",
"path": "PayPal.Billing_Plans",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "PayPal.Billing_Plans_Payment_Definition",
"path": "PayPal.Billing_Plans_Payment_Definition",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "PayPal.Billing_Plans_Payment_Definition_Charge_Models",
"path": "PayPal.Billing_Plans_Payment_Definition_Charge_Models",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "PayPal.Catalog_Products",
"path": "PayPal.Catalog_Products",
"canPreview": true,
"canFetchSchema": true
}
]
Para inspecionar a estrutura de uma tabela do seu sistema de pagamentos, execute uma solicitação GET enquanto especifica o caminho de uma tabela como um parâmetro de consulta.
Formato da API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parâmetro | Descrição |
---|---|
{BASE_CONNECTION_ID} |
A ID da conexão do seu sistema de pagamentos. |
{TABLE_PATH} |
O caminho de uma tabela no seu sistema de pagamentos. |
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/24151d58-ffa7-4960-951d-58ffa7396097/explore?objectType=table&object=test1.Mytable' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna a estrutura da tabela especificada. Detalhes sobre cada coluna da tabela estão localizados em elementos do columns
matriz.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Product_Id",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Product_Name",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Description",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Type",
"type": "string",
"xdm": {
"type": "string"
}
},
]
}
}
Seguindo este tutorial, você explorou seu sistema de pagamentos, encontrou o caminho da tabela na qual deseja assimilar Platforme obteve informações sobre a sua estrutura. Você pode usar essas informações no próximo tutorial para coletar dados do seu sistema de pagamentos e trazê-los para a Plataforma.