Clickfin

Referência da API
Portal oficial
GET/market-segment/{segmentId}

Obter um segmento por ID

Retorna os detalhes de um segmento de mercado específico pelo seu ID. A consulta é restrita ao licenciado e à empresa selecionada no token; segmentos de outra empresa ou de outro licenciado retornam 404. Requer perfil de Administrador.

AcessoChave de API · market_segments:read
Parâmetros1
Respostas6

Parâmetros

  • segmentIdpath

    ID do segmento a ser retornado (24 caracteres hexadecimais).

Respostas

200Sucesso

Segmento retornado com sucesso.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Falha de autorização.

404Erro

Segmento não encontrado.

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.