Qual é minha organização?
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?
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?
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?
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?
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?
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?
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:
- Um navegador da Web moderno e padrão. Embora a versão mais recente do Chrome seja recomendada, versões principais atuais e anteriores do Firefox, Internet Explorer e Safari também são compatíveis.
- Cada vez que uma nova versão principal é lançada, o Experience Platform começa a oferecer suporte à versão mais recente enquanto o suporte à terceira versão mais recente é descartado.
- Todos os navegadores devem ter os cookies e o JavaScript ativados.
Para API e interações de desenvolvedor:
- Um ambiente de desenvolvimento para desenvolver integrações REST, streaming e Webhook.
Erros e solução de problemas
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.