Autenticação

Como Obter suas CredenciaisCopiar link da seção

1. Acesse app.v4mos.ai

2. Faça login utilizando suas credenciais.

3. Acesse Configurações e depois acesse a guia de API de Dados.

   Atenção

   É necessário ter permissão de Admin na organização para acessar e visualizar a aba de API de Dados.

   

4. Suas credenciais (client_id e client_secret) serão geradas e exibidas para copiar.

Usando as CredenciaisCopiar link da seção

Inclua as credenciais em todas as requisições através dos cabeçalhos HTTP obrigatórios:

x-client-id: seu_client_id
x-client-secret: seu_client_secret

Exemplo de RequisiçãoCopiar link da seção

curl -X GET "https://data.v4mos.ai/v1/google/ads/campaigns?organizationId=organization_123&createdStart=2024-01-01T00:00:00Z&createdEnd=2024-01-31T23:59:59Z&page=1&limit=500&orderBy=metrics_cost&orderDirection=DESC" \
  -H "x-client-id: seu_client_id" \
  -H "x-client-secret: seu_client_secret" \
  -H "Content-Type: application/json"

Parâmetro Obrigatório: organizationIdCopiar link da seção

Todas as requisições exigem o parâmetro organizationId para identificar a organização.

CaracterísticasCopiar link da seção

• Deve ser enviado como query parameter em cada requisição
• É obrigatório em todas as chamadas
• Requisições sem organizationId retornarão erro de validação

ExemploCopiar link da seção

GET https://data.v4mos.ai/v1/google/ads/campaigns?organizationId=organization_123&limit=100

SegurançaCopiar link da seção

• Mantenha suas credenciais seguras: Nunca compartilhe ou exponha publicamente seu client_id e client_secret
• Não versione credenciais: Nunca commite credenciais em repositórios de código
• Use variáveis de ambiente: Armazene credenciais em variáveis de ambiente ou gerenciadores de secrets
• Rotação de credenciais: Gere novas credenciais periodicamente
• Revogação: Se suas credenciais forem comprometidas, gere novas imediatamente na plataforma

Erros de AutenticaçãoCopiar link da seção

Credenciais Ausentes ou InválidasCopiar link da seção

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "message": "Unauthorized"
}

organizationId AusenteCopiar link da seção

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": "Validation Error",
  "message": "O parâmetro organizationId é obrigatório"
}