Clickfin

Referência da API
Portal oficial
GET/service/{serviceId}

Obter um serviço por ID

Retorna os detalhes de um serviço específico pelo seu ID. O serviço deve pertencer ao licenciado e à empresa selecionada no token; caso contrário, retorna 404 SERVICE.GET.NOT_FOUND, inclusive para serviço de outra empresa do mesmo licenciado. Disponível para qualquer perfil da empresa (não exige perfil de Administrador).

AcessoChave de API · services:read
Parâmetros1
Respostas7

Parâmetros

  • serviceIdpath

    ID do serviço a ser retornado (24 caracteres; outro tamanho responde 400).

Respostas

200Sucesso

Serviço retornado com sucesso.

400Erro

ID com tamanho diferente de 24 caracteres ou empresa não selecionada no token.

401Erro

Token ausente, inválido ou expirado.

403Erro

Acesso comercial do licenciado bloqueado.

404Erro

Serviço não encontrado, excluído, de outra empresa ou de outro licenciado.

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.