Guia de solução de problemas e perguntas frequentes do Experience Platform

Este documento fornece respostas a perguntas frequentes sobre o Adobe Experience Platform, bem como um guia de solução de problemas de alto nível para erros comuns que podem ser encontrados em qualquer API do Experience Platform. Para obter guias de solução de problemas sobre serviços Experience Platform individuais, consulte o diretório de solução de problemas de serviço abaixo.

Perguntas frequentes faq

Veja a seguir uma lista de respostas para perguntas frequentes sobre o Adobe Experience Platform.

O que são Experience Platform APIs? what-are-experience-platform-apis

Experience Platform oferece várias APIs RESTful que usam solicitações HTTP para acessar recursos Experience Platform. Cada uma dessas APIs de serviço expõe vários endpoints e permite executar operações para listar (GET), pesquisar (GET), editar (PUT e/ou PATCH) e excluir (DELETE) recursos. Para obter mais informações sobre endpoints e operações específicos disponíveis para cada serviço, consulte a documentação de Referência da API no Adobe I/O.

Como formatar uma solicitação de API? how-do-i-format-an-api-request

Os formatos de solicitação variam dependendo da API Experience Platform que está sendo usada. A melhor maneira de saber como estruturar suas chamadas de API é seguindo os exemplos fornecidos na documentação do serviço Experience Platform específico que você está usando.

Para obter mais informações sobre como formatar solicitações de API, consulte a seção Guia de introdução à API do Experience Platform lendo chamadas de API de exemplo.

Qual é minha organização? what-is-my-ims-organization

Uma organização é uma representação da Adobe de um cliente. Todas as soluções licenciadas da Adobe são integradas a essa organização do cliente. Quando uma organização tem direito a Experience Platform, ela pode atribuir acesso aos desenvolvedores. A ID de organização (x-gw-ims-org-id) representa a organização para a qual uma chamada de API deve ser executada e, portanto, é necessária como um cabeçalho em todas as solicitações de API. Esta ID pode ser encontrada por meio da Adobe Developer Console: na guia Integrações, navegue até a seção Visão geral de qualquer integração específica para encontrar a ID em Credenciais de Cliente. Para obter uma apresentação passo a passo de como autenticar no Experience Platform, consulte o tutorial de autenticação.

Onde encontro minha chave de API? where-can-i-find-my-api-key

Uma chave de API é necessária como cabeçalho em todas as solicitações de API. Ele pode ser encontrado por meio da Adobe Developer Console. No console, na guia Integrações, navegue até a seção Visão geral de uma integração específica e você encontrará a chave em Credenciais do Cliente. Para obter uma apresentação passo a passo de como autenticar no Experience Platform, consulte o tutorial de autenticação.

Como obter um token de acesso? how-do-i-get-an-access-token

Os tokens de acesso são necessários no cabeçalho de Autorização de todas as chamadas de API. Elas podem ser geradas usando um comando CURL, desde que você tenha acesso a uma integração para uma organização. Os tokens de acesso são válidos somente por 24 horas, após as quais um novo token deve ser gerado para continuar usando a API. Para obter detalhes sobre a geração de tokens de acesso, consulte o tutorial de autenticação.

Como usar parâmetros de consulta? how-do-i-user-query-parameters

Alguns pontos de extremidade de API Experience Platform aceitam parâmetros de consulta para localizar informações específicas e filtrar os resultados retornados na resposta. Os parâmetros de consulta são anexados a caminhos de solicitação com um símbolo de ponto de interrogação (?), seguido por um ou mais parâmetros de consulta usando o formato paramName=paramValue. Ao combinar vários parâmetros em uma única chamada, você deve usar um E comercial (&) para separar parâmetros individuais. O exemplo a seguir demonstra como uma solicitação que usa vários parâmetros de consulta é representada na documentação.

Exemplos de parâmetros de consulta comumente usados incluem:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Para obter informações detalhadas sobre quais parâmetros de consulta estão disponíveis para um serviço ou endpoint específico, consulte a documentação específica do serviço.

Como indicar um campo JSON para atualizar em uma solicitação PATCH? how-do-i-indicate-a-json-field-to-update-in-a-patch-request

Muitas operações do PATCH nas APIs Experience Platform usam cadeias de caracteres JSON Pointer para indicar propriedades JSON a serem atualizadas. Normalmente, eles são incluídos em cargas de solicitação usando o formato Patch JSON. Consulte o guia de fundamentos de API para obter informações detalhadas sobre a sintaxe necessária para essas tecnologias.

Posso usar o Postman para fazer chamadas para APIs do Experience Platform? how-do-i-use-postman-to-make-calls-to-platform-apis

O Postman é uma ferramenta útil para visualizar chamadas para APIs RESTful. O guia de introdução à API do Experience Platform contém um vídeo e instruções para importar coleções do Postman. Além disso, é fornecida uma lista de coleções do Postman para cada serviço.

Quais são os requisitos de sistema para o Experience Platform? what-are-the-system-requirements-for-platform

Dependendo de você estar usando a interface do usuário ou a API, os seguintes requisitos de sistema se aplicam:

Para operações baseadas na interface do usuário:

Para API e interações de desenvolvedor:

Erros e solução de problemas errors-and-troubleshooting

Esta é uma lista de erros que você pode encontrar ao usar qualquer serviço Experience Platform. Para obter guias de solução de problemas sobre serviços Experience Platform individuais, consulte o diretório de solução de problemas de serviço abaixo.

Códigos de status da API api-status-codes

Os códigos de status a seguir podem ser encontrados em qualquer API Experience Platform. Cada um tem uma variedade de causas, portanto, as explicações fornecidas nesta seção são de natureza geral. Para obter mais detalhes sobre erros específicos em serviços individuais Experience Platform, consulte o diretório de solução de problemas de serviço abaixo.

Erros no cabeçalho da solicitação request-header-errors

Todas as chamadas de API em Experience Platform exigem cabeçalhos de solicitação específicos. Para ver quais cabeçalhos são necessários para serviços individuais, consulte a documentação de Referência da API. Para localizar os valores dos cabeçalhos de autenticação necessários, consulte o Tutorial de autenticação. Se qualquer um desses cabeçalhos estiver ausente ou for inválido ao fazer uma chamada de API, os seguintes erros poderão ocorrer.

Token OAuth ausente oauth-token-is-missing

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Esta mensagem de erro é exibida quando um cabeçalho Authorization está ausente em uma solicitação de API. Verifique se o cabeçalho de Autorização está incluído com um token de acesso válido antes de tentar novamente.

O token OAuth é inválido oauth-token-is-not-valid

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Esta mensagem de erro é exibida quando o token de acesso fornecido no cabeçalho Authorization não é válido. Verifique se o token foi inserido corretamente ou gere um novo token no Console do Adobe I/O.

A chave de API é obrigatória api-key-is-required

{
    "error_code": "403000",
    "message": "Api Key is required"
}

Esta mensagem de erro é exibida quando um cabeçalho de chave de API (x-api-key) está ausente em uma solicitação de API. Verifique se o cabeçalho está incluído com uma chave de API válida antes de tentar novamente.

A chave de API é inválida api-key-is-invalid

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

Esta mensagem de erro é exibida quando o valor do cabeçalho da chave de API fornecido (x-api-key) é inválido. Verifique se você inseriu a chave corretamente antes de tentar novamente. Se você não souber sua chave de API, poderá encontrá-la no Console do Adobe I/O: na guia Integrações, navegue até a seção Visão geral de uma integração específica para encontrar a chave de API em Credenciais do cliente.

Cabeçalho ausente missing-header

{
    "error_code": "400003",
    "message": "Missing header"
}

Esta mensagem de erro é exibida quando um cabeçalho de organização (x-gw-ims-org-id) está ausente em uma solicitação de API. Verifique se o cabeçalho está incluído com a ID da organização antes de tentar novamente.

O perfil não é válido profile-is-not-valid

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

Esta mensagem de erro é exibida quando o usuário ou a integração do Adobe I/O (identificada pelo token de acesso no cabeçalho Authorization) não tem direito a fazer chamadas para APIs Experience Platform para a organização fornecida no cabeçalho x-gw-ims-org-id. Verifique se você forneceu a ID correta para a organização no cabeçalho antes de tentar novamente. Caso não saiba a ID da organização, é possível encontrá-la no Console do Adobe I/O: na guia Integrações, navegue até a seção Visão geral de uma integração específica para encontrar a ID em Credenciais do cliente.

Erro ao atualizar tag refresh-etag-error

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

Você pode receber um erro de etag se uma alteração tiver sido feita em qualquer entidade de origem ou destino, como fluxo, conexão, conector de origem ou conexão de destino, por outro chamador de API. Devido à incompatibilidade de versões, a alteração que você está tentando fazer não seria aplicada à versão mais recente da entidade.

Para resolver isso, você precisa buscar a entidade novamente, verificar se suas alterações são compatíveis com a nova versão da entidade, colocar a nova tag no cabeçalho If-Match e finalmente fazer a chamada de API.

Tipo de conteúdo válido não especificado valid-content-type-not-specified

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

Esta mensagem de erro é exibida quando uma solicitação POST, PUT ou PATCH tem um cabeçalho Content-Type inválido ou ausente. Verifique se o cabeçalho está incluído na solicitação e se seu valor é application/json.

Região do usuário ausente user-region-is-missing

{
    "error_code": "403027",
    "message": "User region is missing"
}

Essa mensagem de erro é exibida em qualquer um dos casos abaixo:

Diretório de solução de problemas de serviço service-troubleshooting-directory

Veja a seguir uma lista de guias de solução de problemas e a documentação de referência da API para as APIs Experience Platform. Cada guia de solução de problemas fornece respostas a perguntas frequentes e soluções para problemas específicos de serviços individuais do Experience Platform. Os documentos de referência da API fornecem um guia abrangente para todos os endpoints disponíveis para cada serviço e mostram exemplos de corpos de solicitação, respostas e códigos de erro que você pode receber.